Documentation/git-worktree: split technical info from general description
The DESCRIPTION section should provide a high-level overview of linked worktree functionality to bring users up to speed quickly, without overloading them with low-level details, so relocate the technical information to a new DETAILS section. Signed-off-by: Eric Sunshine <sunshine@sunshineco.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
6d3824cf92
commit
af189b4cbe
@ -24,47 +24,18 @@ 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
|
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.
|
bare repository) and zero or more linked working trees.
|
||||||
|
|
||||||
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
|
|
||||||
number to make it unique. For example, when `$GIT_DIR=/path/main/.git` the
|
|
||||||
command `git checkout --to /path/other/test-next next` creates the linked
|
|
||||||
working tree in `/path/other/test-next` and also creates a
|
|
||||||
`$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
|
|
||||||
if `test-next` is already taken).
|
|
||||||
|
|
||||||
Within a linked working tree, $GIT_DIR is set to point to this private
|
|
||||||
directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
|
|
||||||
$GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
|
|
||||||
(e.g. `/path/main/.git`). These settings are made in a `.git` file located at
|
|
||||||
the top directory of the linked working tree.
|
|
||||||
|
|
||||||
Path resolution via `git rev-parse --git-path` uses either
|
|
||||||
$GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
|
|
||||||
linked working tree `git rev-parse --git-path HEAD` returns
|
|
||||||
`/path/main/.git/worktrees/test-next/HEAD` (not
|
|
||||||
`/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
|
|
||||||
rev-parse --git-path refs/heads/master` uses
|
|
||||||
$GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
|
|
||||||
since refs are shared across all working trees.
|
|
||||||
|
|
||||||
See linkgit:gitrepository-layout[5] for more information. The rule of
|
|
||||||
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.
|
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
|
The working tree's administrative files in the repository (see
|
||||||
directory will eventually be removed automatically (see
|
"DETAILS" below) will eventually be removed automatically (see
|
||||||
`gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
|
`gc.pruneworktreesexpire` in linkgit::git-config[1]), or you can run
|
||||||
`git worktree prune` in the main or any linked working tree to
|
`git worktree prune` in the main or any linked working tree to
|
||||||
clean up any stale entries in $GIT_DIR/worktrees.
|
clean up any stale administrative files.
|
||||||
|
|
||||||
If you move a linked working directory to another file system, or
|
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
|
within a file system that does not support hard links, you need to run
|
||||||
at least one git command inside the linked working directory
|
at least one git command inside the linked working directory
|
||||||
(e.g. `git status`) in order to update its entry in $GIT_DIR/worktrees
|
(e.g. `git status`) in order to update its administrative files in the
|
||||||
so that it does not get automatically removed.
|
repository so that they do not get automatically pruned.
|
||||||
|
|
||||||
To prevent a $GIT_DIR/worktrees entry from from being pruned (which
|
To prevent a $GIT_DIR/worktrees entry from from being pruned (which
|
||||||
can be useful in some situations, such as when the
|
can be useful in some situations, such as when the
|
||||||
@ -97,6 +68,37 @@ OPTIONS
|
|||||||
--expire <time>::
|
--expire <time>::
|
||||||
With `prune`, only expire unused worktrees older than <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
|
||||||
|
number to make it unique. For example, when `$GIT_DIR=/path/main/.git` the
|
||||||
|
command `git checkout --to /path/other/test-next next` creates the linked
|
||||||
|
working tree in `/path/other/test-next` and also creates a
|
||||||
|
`$GIT_DIR/worktrees/test-next` directory (or `$GIT_DIR/worktrees/test-next1`
|
||||||
|
if `test-next` is already taken).
|
||||||
|
|
||||||
|
Within a linked working tree, $GIT_DIR is set to point to this private
|
||||||
|
directory (e.g. `/path/main/.git/worktrees/test-next` in the example) and
|
||||||
|
$GIT_COMMON_DIR is set to point back to the main working tree's $GIT_DIR
|
||||||
|
(e.g. `/path/main/.git`). These settings are made in a `.git` file located at
|
||||||
|
the top directory of the linked working tree.
|
||||||
|
|
||||||
|
Path resolution via `git rev-parse --git-path` uses either
|
||||||
|
$GIT_DIR or $GIT_COMMON_DIR depending on the path. For example, in the
|
||||||
|
linked working tree `git rev-parse --git-path HEAD` returns
|
||||||
|
`/path/main/.git/worktrees/test-next/HEAD` (not
|
||||||
|
`/path/other/test-next/.git/HEAD` or `/path/main/.git/HEAD`) while `git
|
||||||
|
rev-parse --git-path refs/heads/master` uses
|
||||||
|
$GIT_COMMON_DIR and returns `/path/main/.git/refs/heads/master`,
|
||||||
|
since refs are shared across all working trees.
|
||||||
|
|
||||||
|
See linkgit:gitrepository-layout[5] for more information. The rule of
|
||||||
|
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.
|
||||||
|
|
||||||
BUGS
|
BUGS
|
||||||
----
|
----
|
||||||
Multiple checkout support for submodules is incomplete. It is NOT
|
Multiple checkout support for submodules is incomplete. It is NOT
|
||||||
|
Loading…
Reference in New Issue
Block a user