From: Derrick Stolee via GitGitGadget Date: Sun, 20 Feb 2022 17:54:23 GMT Subject: [PATCH 07/11] worktree: use 'worktree' over 'working tree' Message-ID: <00d261d0a2a4e87e774990d1cef3b875dde373d5.1645379667.git.gitgitgadget@gmail.com> In-Reply-To: From: Derrick Stolee It is helpful to distinguish between a 'working tree' and a 'worktree'. A worktree contains a working tree plus additional metadata. This metadata includes per-worktree refs and worktree-specific config. This is the third of multiple changes to git-worktree.txt, restricted to the OPTIONS section. Signed-off-by: Derrick Stolee --- Documentation/git-worktree.txt | 42 +++++++++++++++++----------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt index e9ba58fb8bc..10021c85e77 100644 --- a/Documentation/git-worktree.txt +++ b/Documentation/git-worktree.txt @@ -159,25 +159,25 @@ OPTIONS -f:: --force:: - By default, `add` refuses to create a new working tree when + By default, `add` refuses to create a new worktree when `` is a branch name and is already checked out by - another working tree, or if `` is already assigned to some - working tree but is missing (for instance, if `` was deleted + another worktree, or if `` is already assigned to some + worktree but is missing (for instance, if `` was deleted manually). This option overrides these safeguards. To add a missing but - locked working tree path, specify `--force` twice. + locked worktree path, specify `--force` twice. + -`move` refuses to move a locked working tree unless `--force` is specified -twice. If the destination is already assigned to some other working tree but is +`move` refuses to move a locked worktree unless `--force` is specified +twice. If the destination is already assigned to some other worktree but is missing (for instance, if `` was deleted manually), then `--force` allows the move to proceed; use `--force` twice if the destination is locked. + -`remove` refuses to remove an unclean working tree unless `--force` is used. -To remove a locked working tree, specify `--force` twice. +`remove` refuses to remove an unclean worktree unless `--force` is used. +To remove a locked worktree, specify `--force` twice. -b :: -B :: With `add`, create a new branch named `` starting at - ``, and check out `` into the new working tree. + ``, and check out `` into the new worktree. If `` is omitted, it defaults to `HEAD`. By default, `-b` refuses to create a new branch if it already exists. `-B` overrides this safeguard, resetting `` to @@ -185,7 +185,7 @@ To remove a locked working tree, specify `--force` twice. -d:: --detach:: - With `add`, detach `HEAD` in the new working tree. See "DETACHED HEAD" + With `add`, detach `HEAD` in the new worktree. See "DETACHED HEAD" in linkgit:git-checkout[1]. --[no-]checkout:: @@ -211,7 +211,7 @@ This can also be set up as the default behaviour by using the `--track` in linkgit:git-branch[1] for details. --lock:: - Keep the working tree locked after creation. This is the + Keep the worktree locked after creation. This is the equivalent of `git worktree lock` after `git worktree add`, but without a race condition. @@ -236,22 +236,22 @@ This can also be set up as the default behaviour by using the With `list`, output additional information about worktrees (see below). --expire