Skip to content

Commit e536b1f

Browse files
szedergitster
authored andcommitted
Documentation: mention more worktree-specific exceptions
If a directory in $GIT_DIR is overridden when $GIT_COMMON_DIR is set, then usually all paths within that directory are overridden as well. There are a couple of exceptions, though, and two of them, namely 'refs/rewritten' and 'logs/HEAD' are not mentioned in 'gitrepository-layout'. Document them as well. Signed-off-by: SZEDER Gábor <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5fa0f52 commit e536b1f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

Documentation/gitrepository-layout.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,9 +96,9 @@ refs::
9696
directory. The 'git prune' command knows to preserve
9797
objects reachable from refs found in this directory and
9898
its subdirectories.
99-
This directory is ignored (except refs/bisect and
100-
refs/worktree) if $GIT_COMMON_DIR is set and
101-
"$GIT_COMMON_DIR/refs" will be used instead.
99+
This directory is ignored (except refs/bisect,
100+
refs/rewritten and refs/worktree) if $GIT_COMMON_DIR is
101+
set and "$GIT_COMMON_DIR/refs" will be used instead.
102102

103103
refs/heads/`name`::
104104
records tip-of-the-tree commit objects of branch `name`
@@ -240,8 +240,8 @@ remotes::
240240
logs::
241241
Records of changes made to refs are stored in this directory.
242242
See linkgit:git-update-ref[1] for more information. This
243-
directory is ignored if $GIT_COMMON_DIR is set and
244-
"$GIT_COMMON_DIR/logs" will be used instead.
243+
directory is ignored (except logs/HEAD) if $GIT_COMMON_DIR is
244+
set and "$GIT_COMMON_DIR/logs" will be used instead.
245245

246246
logs/refs/heads/`name`::
247247
Records all changes made to the branch tip named `name`.

0 commit comments

Comments
 (0)