append_one_rev(): rewrite to work with object_id
[gitweb.git] / Documentation / gitrepository-layout.txt
index 2b5966a4038220eb04d622401b80d9eb8133ac34..7173b38830015ba1be09772e80cf3973c10bab69 100644 (file)
@@ -240,10 +240,41 @@ shallow::
        file is ignored if $GIT_COMMON_DIR is set and
        "$GIT_COMMON_DIR/shallow" will be used instead.
 
+commondir::
+       If this file exists, $GIT_COMMON_DIR (see linkgit:git[1]) 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".
+
 modules::
-       Contains the git-repositories of the submodules. This
-       directory is ignored if $GIT_COMMON_DIR is set and
-       "$GIT_COMMON_DIR/modules" will be used instead.
+       Contains the git-repositories of the submodules.
+
+worktrees::
+       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.
+
+worktrees/<id>/gitdir::
+       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.
+
+worktrees/<id>/locked::
+       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 `worktrees/<id>` could be
+       removed. The file's content contains a reason string on why
+       the repository is locked.
+
+worktrees/<id>/link::
+       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.
 
 SEE ALSO
 --------