Skip to content

Commit 6036be1

Browse files
derrickstoleegitster
authored andcommitted
worktree: use 'worktree' over 'working tree'
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 5997014 commit 6036be1

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

Documentation/git-worktree.txt

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -160,33 +160,33 @@ OPTIONS
160160

161161
-f::
162162
--force::
163-
By default, `add` refuses to create a new working tree when
163+
By default, `add` refuses to create a new worktree when
164164
`<commit-ish>` is a branch name and is already checked out by
165-
another working tree, or if `<path>` is already assigned to some
166-
working tree but is missing (for instance, if `<path>` was deleted
165+
another worktree, or if `<path>` is already assigned to some
166+
worktree but is missing (for instance, if `<path>` was deleted
167167
manually). This option overrides these safeguards. To add a missing but
168-
locked working tree path, specify `--force` twice.
168+
locked worktree path, specify `--force` twice.
169169
+
170-
`move` refuses to move a locked working tree unless `--force` is specified
171-
twice. If the destination is already assigned to some other working tree but is
170+
`move` refuses to move a locked worktree unless `--force` is specified
171+
twice. If the destination is already assigned to some other worktree but is
172172
missing (for instance, if `<new-path>` was deleted manually), then `--force`
173173
allows the move to proceed; use `--force` twice if the destination is locked.
174174
+
175-
`remove` refuses to remove an unclean working tree unless `--force` is used.
176-
To remove a locked working tree, specify `--force` twice.
175+
`remove` refuses to remove an unclean worktree unless `--force` is used.
176+
To remove a locked worktree, specify `--force` twice.
177177

178178
-b <new-branch>::
179179
-B <new-branch>::
180180
With `add`, create a new branch named `<new-branch>` starting at
181-
`<commit-ish>`, and check out `<new-branch>` into the new working tree.
181+
`<commit-ish>`, and check out `<new-branch>` into the new worktree.
182182
If `<commit-ish>` is omitted, it defaults to `HEAD`.
183183
By default, `-b` refuses to create a new branch if it already
184184
exists. `-B` overrides this safeguard, resetting `<new-branch>` to
185185
`<commit-ish>`.
186186

187187
-d::
188188
--detach::
189-
With `add`, detach `HEAD` in the new working tree. See "DETACHED HEAD"
189+
With `add`, detach `HEAD` in the new worktree. See "DETACHED HEAD"
190190
in linkgit:git-checkout[1].
191191

192192
--[no-]checkout::
@@ -212,7 +212,7 @@ This can also be set up as the default behaviour by using the
212212
`--track` in linkgit:git-branch[1] for details.
213213

214214
--lock::
215-
Keep the working tree locked after creation. This is the
215+
Keep the worktree locked after creation. This is the
216216
equivalent of `git worktree lock` after `git worktree add`,
217217
but without a race condition.
218218

@@ -237,22 +237,22 @@ This can also be set up as the default behaviour by using the
237237
With `list`, output additional information about worktrees (see below).
238238

239239
--expire <time>::
240-
With `prune`, only expire unused working trees older than `<time>`.
240+
With `prune`, only expire unused worktrees older than `<time>`.
241241
+
242-
With `list`, annotate missing working trees as prunable if they are
243-
older than `<time>`.
242+
With `list`, annotate missing worktrees as prunable if they are older than
243+
`<time>`.
244244

245245
--reason <string>::
246-
With `lock` or with `add --lock`, an explanation why the working tree is locked.
246+
With `lock` or with `add --lock`, an explanation why the worktree
247+
is locked.
247248

248249
<worktree>::
249-
Working trees can be identified by path, either relative or
250-
absolute.
250+
Worktrees can be identified by path, either relative or absolute.
251251
+
252-
If the last path components in the working tree's path is unique among
253-
working trees, it can be used to identify a working tree. For example if
254-
you only have two working trees, at `/abc/def/ghi` and `/abc/def/ggg`,
255-
then `ghi` or `def/ghi` is enough to point to the former working tree.
252+
If the last path components in the worktree's path is unique among
253+
worktrees, it can be used to identify a worktree. For example if you only
254+
have two worktrees, at `/abc/def/ghi` and `/abc/def/ggg`, then `ghi` or
255+
`def/ghi` is enough to point to the former worktree.
256256

257257
REFS
258258
----

0 commit comments

Comments
 (0)