]> git.ipfire.org Git - thirdparty/git.git/commitdiff
Documentation: mention more worktree-specific exceptions
authorSZEDER Gábor <szeder.dev@gmail.com>
Mon, 21 Oct 2019 16:00:39 +0000 (18:00 +0200)
committerJunio C Hamano <gitster@pobox.com>
Wed, 23 Oct 2019 03:53:50 +0000 (12:53 +0900)
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 <szeder.dev@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/gitrepository-layout.txt

index 216b11ee88f4e9c5b10278e037f3b1c51173bc6d..f4066fd0261074d7700913337bc23956956d985d 100644 (file)
@@ -96,9 +96,9 @@ refs::
        directory.  The 'git prune' command knows to preserve
        objects reachable from refs found in this directory and
        its subdirectories.
-       This directory is ignored (except refs/bisect and
-       refs/worktree) if $GIT_COMMON_DIR is set and
-       "$GIT_COMMON_DIR/refs" will be used instead.
+       This directory is ignored (except refs/bisect,
+       refs/rewritten and refs/worktree) if $GIT_COMMON_DIR is
+       set and "$GIT_COMMON_DIR/refs" will be used instead.
 
 refs/heads/`name`::
        records tip-of-the-tree commit objects of branch `name`
@@ -240,8 +240,8 @@ remotes::
 logs::
        Records of changes made to refs are stored in this directory.
        See linkgit:git-update-ref[1] for more information. This
-       directory is ignored if $GIT_COMMON_DIR is set and
-       "$GIT_COMMON_DIR/logs" will be used instead.
+       directory is ignored (except logs/HEAD) if $GIT_COMMON_DIR is
+       set and "$GIT_COMMON_DIR/logs" will be used instead.
 
 logs/refs/heads/`name`::
        Records all changes made to the branch tip named `name`.