summaryrefslogtreecommitdiffstats
path: root/gitrepository-layout.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2015-05-11 15:41:02 -0700
committerJunio C Hamano <gitster@pobox.com>2015-05-11 15:41:02 -0700
commit4cc4a84ff7c2cf78099e14d821eb027d5ba66d89 (patch)
tree8549c559df49ef0328eea3aa0d8b6b9b1a0a50a6 /gitrepository-layout.html
parentdd5004ad952f72405f1265393b3f95dbe212992a (diff)
downloadgit-htmldocs-4cc4a84ff7c2cf78099e14d821eb027d5ba66d89.tar.gz
Autogenerated HTML docs for v2.4.0-194-gc5180
Diffstat (limited to 'gitrepository-layout.html')
-rw-r--r--gitrepository-layout.html103
1 files changed, 92 insertions, 11 deletions
diff --git a/gitrepository-layout.html b/gitrepository-layout.html
index 51ad9aeda..ffbe5afc1 100644
--- a/gitrepository-layout.html
+++ b/gitrepository-layout.html
@@ -805,6 +805,8 @@ use with dumb transports but otherwise is OK as long as
<code>objects/info/alternates</code> points at the object stores it
borrows from.
</p>
+<div class="paragraph"><p>This directory is ignored if $GIT_COMMON_DIR is set and
+"$GIT_COMMON_DIR/objects" will be used instead.</p></div>
</li>
</ol></div>
</dd>
@@ -887,7 +889,8 @@ refs
References are stored in subdirectories of this
directory. The <em>git prune</em> command knows to preserve
objects reachable from refs found in this directory and
- its subdirectories.
+ its subdirectories. This directory is ignored if $GIT_COMMON_DIR
+ is set and "$GIT_COMMON_DIR/refs" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -934,7 +937,8 @@ packed-refs
<p>
records the same information as refs/heads/, refs/tags/,
and friends record in a more efficient way. See
- <a href="git-pack-refs.html">git-pack-refs(1)</a>.
+ <a href="git-pack-refs.html">git-pack-refs(1)</a>. This file is ignored if $GIT_COMMON_DIR
+ is set and "$GIT_COMMON_DIR/packed-refs" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -959,6 +963,16 @@ is often called <em>detached HEAD.</em> See <a href="git-checkout.html">git-che
for details.</p></div>
</dd>
<dt class="hdlist1">
+config
+</dt>
+<dd>
+<p>
+ Repository specific configuration file. This file is ignored
+ if $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/config" will be
+ used instead.
+</p>
+</dd>
+<dt class="hdlist1">
branches
</dt>
<dd>
@@ -969,7 +983,9 @@ branches
<em>name</em> can be given to these commands in place of
<em>repository</em> argument. See the REMOTES section in
<a href="git-fetch.html">git-fetch(1)</a> for details. This mechanism is legacy
- and not likely to be found in modern repositories.
+ and not likely to be found in modern repositories. This
+ directory is ignored if $GIT_COMMON_DIR is set and
+ "$GIT_COMMON_DIR/branches" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -983,7 +999,8 @@ hooks
default. To enable, the <code>.sample</code> suffix has to be
removed from the filename by renaming.
Read <a href="githooks.html">githooks(5)</a> for more details about
- each hook.
+ each hook. This directory is ignored if $GIT_COMMON_DIR is set
+ and "$GIT_COMMON_DIR/hooks" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -1010,7 +1027,8 @@ info
<dd>
<p>
Additional information about the repository is recorded
- in this directory.
+ in this directory. This directory is ignored if $GIT_COMMON_DIR
+ is set and "$GIT_COMMON_DIR/index" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -1074,7 +1092,9 @@ remotes
when interacting with remote repositories via <em>git fetch</em>,
<em>git pull</em> and <em>git push</em> commands. See the REMOTES section
in <a href="git-fetch.html">git-fetch(1)</a> for details. This mechanism is legacy
- and not likely to be found in modern repositories.
+ and not likely to be found in modern repositories. This
+ directory is ignored if $GIT_COMMON_DIR is set and
+ "$GIT_COMMON_DIR/remotes" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -1082,9 +1102,10 @@ logs
</dt>
<dd>
<p>
- Records of changes made to refs are stored in this
- directory. See <a href="git-update-ref.html">git-update-ref(1)</a>
- for more information.
+ Records of changes made to refs are stored in this directory.
+ See <a href="git-update-ref.html">git-update-ref(1)</a> for more information. This
+ directory is ignored if $GIT_COMMON_DIR is set and
+ "$GIT_COMMON_DIR/logs" will be used instead.
</p>
</dd>
<dt class="hdlist1">
@@ -1110,7 +1131,21 @@ shallow
<p>
This is similar to <code>info/grafts</code> but is internally used
and maintained by shallow clone mechanism. See <code>--depth</code>
- option to <a href="git-clone.html">git-clone(1)</a> and <a href="git-fetch.html">git-fetch(1)</a>.
+ option to <a href="git-clone.html">git-clone(1)</a> and <a href="git-fetch.html">git-fetch(1)</a>. This
+ file is ignored if $GIT_COMMON_DIR is set and
+ "$GIT_COMMON_DIR/shallow" will be used instead.
+</p>
+</dd>
+<dt class="hdlist1">
+commondir
+</dt>
+<dd>
+<p>
+ If this file exists, $GIT_COMMON_DIR (see <a href="git.html">git(1)</a>) will
+ be set to the path specified in this file if it is not
+ explicitly set. If the specified path is relative, it is
+ relative to $GIT_DIR. The repository with commondir is
+ incomplete without the repository pointed by "commondir".
</p>
</dd>
<dt class="hdlist1">
@@ -1121,6 +1156,52 @@ modules
Contains the git-repositories of the submodules.
</p>
</dd>
+<dt class="hdlist1">
+worktrees
+</dt>
+<dd>
+<p>
+ Contains worktree specific information of linked
+ checkouts. Each subdirectory contains the worktree-related
+ part of a linked checkout. This directory is ignored if
+ $GIT_COMMON_DIR is set and "$GIT_COMMON_DIR/worktrees" will be
+ used instead.
+</p>
+</dd>
+<dt class="hdlist1">
+worktrees/&lt;id&gt;/gitdir
+</dt>
+<dd>
+<p>
+ A text file containing the absolute path back to the .git file
+ that points to here. This is used to check if the linked
+ repository has been manually removed and there is no need to
+ keep this directory any more. mtime of this file should be
+ updated every time the linked repository is accessed.
+</p>
+</dd>
+<dt class="hdlist1">
+worktrees/&lt;id&gt;/locked
+</dt>
+<dd>
+<p>
+ If this file exists, the linked repository may be on a
+ portable device and not available. It does not mean that the
+ linked repository is gone and <code>worktrees/&lt;id&gt;</code> could be
+ removed. The file&#8217;s content contains a reason string on why
+ the repository is locked.
+</p>
+</dd>
+<dt class="hdlist1">
+worktrees/&lt;id&gt;/link
+</dt>
+<dd>
+<p>
+ If this file exists, it is a hard link to the linked .git
+ file. It is used to detect if the linked repository is
+ manually removed.
+</p>
+</dd>
</dl></div>
</div>
</div>
@@ -1147,7 +1228,7 @@ modules
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2014-07-16 14:50:19 PDT
+Last updated 2015-05-11 15:40:21 PDT
</div>
</div>
</body>