summaryrefslogtreecommitdiffstats
path: root/gitrepository-layout.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2013-02-05 21:13:21 -0800
committerJunio C Hamano <gitster@pobox.com>2013-02-05 21:13:21 -0800
commit076ffcc834f02a4f11d7f4fe8825be3b065020ff (patch)
tree6f5fa28df80c60c9b0a1dfab028d3db33ae22fa0 /gitrepository-layout.html
parent3f2ed6f9b744f05cf2ad32b0c0c80aa149d9fdcb (diff)
downloadgit-htmldocs-076ffcc834f02a4f11d7f4fe8825be3b065020ff.tar.gz
Autogenerated HTML docs for v1.8.1.2-545-g2f19ad
Diffstat (limited to 'gitrepository-layout.html')
-rw-r--r--gitrepository-layout.html38
1 files changed, 28 insertions, 10 deletions
diff --git a/gitrepository-layout.html b/gitrepository-layout.html
index 5d6cee8d9..53404b5aa 100644
--- a/gitrepository-layout.html
+++ b/gitrepository-layout.html
@@ -751,12 +751,30 @@ gitrepository-layout(5) Manual Page
<div class="sect1">
<h2 id="_description">DESCRIPTION</h2>
<div class="sectionbody">
-<div class="paragraph"><p>You may find these things in your git repository (<code>.git</code>
-directory for a repository associated with your working tree, or
-<code>&lt;project&gt;.git</code> directory for a public <em>bare</em> repository. It is
-also possible to have a working tree where <code>.git</code> is a plain
-ASCII file containing <code>gitdir: &lt;path&gt;</code>, i.e. the path to the
-real git repository).</p></div>
+<div class="paragraph"><p>A Git repository comes in two different flavours:</p></div>
+<div class="ulist"><ul>
+<li>
+<p>
+a <code>.git</code> directory at the root of the working tree;
+</p>
+</li>
+<li>
+<p>
+a <code>&lt;project&gt;.git</code> directory that is a <em>bare</em> repository
+ (i.e. without its own working tree), that is typically used for
+ exchanging histories with others by pushing into it and fetching
+ from it.
+</p>
+</li>
+</ul></div>
+<div class="paragraph"><p><strong>Note</strong>: Also you can have a plain text file <code>.git</code> at the root of
+your working tree, containing <code>gitdir: &lt;path&gt;</code> to point at the real
+directory that has the repository. This mechanism is often used for
+a working tree of a submodule checkout, to allow you in the
+containing superproject to <code>git checkout</code> a branch that does not
+have the submodule. The <code>checkout</code> has to remove the entire
+submodule working tree, without losing the submodule repository.</p></div>
+<div class="paragraph"><p>These things may exist in a Git repository.</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
objects
@@ -925,7 +943,7 @@ HEAD
A symref (see glossary) to the <code>refs/heads/</code> namespace
describing the currently active branch. It does not mean
much if the repository is not associated with any working tree
- (i.e. a <em>bare</em> repository), but a valid git repository
+ (i.e. a <em>bare</em> repository), but a valid Git repository
<strong>must</strong> have the HEAD file; some porcelains may use it to
guess the designated "default" branch of the repository
(usually <em>master</em>). It is legal if the named branch
@@ -957,7 +975,7 @@ hooks
</dt>
<dd>
<p>
- Hooks are customization scripts used by various git
+ Hooks are customization scripts used by various Git
commands. A handful of sample hooks are installed when
<em>git init</em> is run, but all of them are disabled by
default. To enable, the <code>.sample</code> suffix has to be
@@ -1020,7 +1038,7 @@ info/exclude
This file, by convention among Porcelains, stores the
exclude pattern list. <code>.gitignore</code> is the per-directory
ignore file. <em>git status</em>, <em>git add</em>, <em>git rm</em> and
- <em>git clean</em> look at it but the core git commands do not look
+ <em>git clean</em> look at it but the core Git commands do not look
at it. See also: <a href="gitignore.html">gitignore(5)</a>.
</p>
</dd>
@@ -1098,7 +1116,7 @@ shallow
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2012-11-13 14:31:09 PST
+Last updated 2013-02-05 21:07:26 PST
</div>
</div>
</body>