Documentation/git-worktree: add high-level 'lock' overview
[gitweb.git] / Documentation / git-worktree.txt
index bf6a1e229c08692bdeaee41ce3cb133ec6663779..0385e9a6dbc0e11651beaede3ceefce782b5d8dc 100644 (file)
@@ -24,6 +24,48 @@ tree is associated with the repository.  This new working tree is called a
 init" or "git clone".  A repository has one main working tree (if it's not a
 bare repository) and zero or more linked working trees.
 
+When you are done with a linked working tree you can simply delete it.
+The working tree's administrative files in the repository (see
+"DETAILS" below) will eventually be removed automatically (see
+`gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
+`git worktree prune` in the main or any linked working tree to
+clean up any stale administrative files.
+
+If you move a linked working directory to another file system, or
+within a file system that does not support hard links, you need to run
+at least one git command inside the linked working directory
+(e.g. `git status`) in order to update its administrative files in the
+repository so that they do not get automatically pruned.
+
+If a linked working tree is stored on a portable device or network share
+which is not always mounted, you can prevent its administrative files from
+being pruned by creating a file named 'lock' alongside the other
+administrative files, optionally containing a plain text reason that
+pruning should be suppressed. See section "DETAILS" for more information.
+
+COMMANDS
+--------
+prune::
+
+Prune working tree information in $GIT_DIR/worktrees.
+
+OPTIONS
+-------
+
+-n::
+--dry-run::
+       With `prune`, do not remove anything; just report what it would
+       remove.
+
+-v::
+--verbose::
+       With `prune`, report all removals.
+
+--expire <time>::
+       With `prune`, only expire unused worktrees older than <time>.
+
+DETAILS
+-------
 Each linked working tree has a private sub-directory in the repository's
 $GIT_DIR/worktrees directory.  The private sub-directory's name is usually
 the base name of the linked working tree's path, possibly appended with a
@@ -53,19 +95,6 @@ thumb is do not make any assumption about whether a path belongs to
 $GIT_DIR or $GIT_COMMON_DIR when you need to directly access something
 inside $GIT_DIR. Use `git rev-parse --git-path` to get the final path.
 
-When you are done with a linked working tree you can simply delete it.
-The working tree's entry in the repository's $GIT_DIR/worktrees
-directory will eventually be removed automatically (see
-`gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
-`git worktree prune` in the main or any linked working tree to
-clean up any stale entries in $GIT_DIR/worktrees.
-
-If you move a linked working directory to another file system, or
-within a file system that does not support hard links, you need to run
-at least one git command inside the linked working directory
-(e.g. `git status`) in order to update its entry in $GIT_DIR/worktrees
-so that it does not get automatically removed.
-
 To prevent a $GIT_DIR/worktrees entry from from being pruned (which
 can be useful in some situations, such as when the
 entry's working tree is stored on a portable device), add a file named
@@ -76,27 +105,6 @@ to `/path/main/.git/worktrees/test-next` then a file named
 `test-next` entry from being pruned.  See
 linkgit:gitrepository-layout[5] for details.
 
-COMMANDS
---------
-prune::
-
-Prune working tree information in $GIT_DIR/worktrees.
-
-OPTIONS
--------
-
--n::
---dry-run::
-       With `prune`, do not remove anything; just report what it would
-       remove.
-
--v::
---verbose::
-       With `prune`, report all removals.
-
---expire <time>::
-       With `prune`, only expire unused worktrees older than <time>.
-
 BUGS
 ----
 Multiple checkout support for submodules is incomplete. It is NOT