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 last of multiple changes to git-worktree.txt, starting at the LIST OUTPUT FORMAT section. The EXAMPLES section has an instance of "working tree" that must stay as it is, because it is not talking about a worktree, but an example of why a user might want to create a worktree. Helped-by: Taylor Blau <me@ttaylorr.com> Signed-off-by: Derrick Stolee <derrickstolee@github.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Derrick Stolee committed
Feb 23, 2022 at 14:29 UTC
07d85380b21653b949f2777903e44aaf0fdb6c44
1 file changed
+7
-7
Documentation/git-worktree.txt
+7
-7
@@ -383,11 +383,11 @@ $ git worktree list
383
/path/to/other-linked-worktree 1234abc (detached HEAD)
384
------------
385
386
-The command also shows annotations for each working tree, according to its state.
386
+The command also shows annotations for each worktree, according to its state.
387
These annotations are:
388
389
- * `locked`, if the working tree is locked.
390
- * `prunable`, if the working tree can be pruned via `git worktree prune`.
389
+ * `locked`, if the worktree is locked.
390
+ * `prunable`, if the worktree can be pruned via `git worktree prune`.
391
392
------------
393
$ git worktree list
@@ -405,14 +405,14 @@ $ git worktree list --verbose
405
/path/to/linked-worktree abcd1234 [master]
406
/path/to/locked-worktree-no-reason abcd5678 (detached HEAD) locked
407
/path/to/locked-worktree-with-reason 1234abcd (brancha)
408
- locked: working tree path is mounted on a portable device
408
+ locked: worktree path is mounted on a portable device
409
/path/to/prunable-worktree 5678abc1 (detached HEAD)
410
prunable: gitdir file points to non-existent location
411
------------
412
413
Note that the annotation is moved to the next line if the additional
414
information is available, otherwise it stays on the same line as the
415
-working tree itself.
415
+worktree itself.
416
417
Porcelain Format
418
~~~~~~~~~~~~~~~~
@@ -421,7 +421,7 @@ label and value separated by a single space. Boolean attributes (like `bare`
421
and `detached`) are listed as a label only, and are present only
422
if the value is true. Some attributes (like `locked`) can be listed as a label
423
only or with a value depending upon whether a reason is available. The first
424
-attribute of a working tree is always `worktree`, an empty line indicates the
424
+attribute of a worktree is always `worktree`, an empty line indicates the
425
end of the record. For example:
426
427
------------
@@ -473,7 +473,7 @@ demands that you fix something immediately. You might typically use
473
linkgit:git-stash[1] to store your changes away temporarily, however, your
474
working tree is in such a state of disarray (with new, moved, and removed
475
files, and other bits and pieces strewn around) that you don't want to risk
476
-disturbing any of it. Instead, you create a temporary linked working tree to
476
+disturbing any of it. Instead, you create a temporary linked worktree to
477
make the emergency fix, remove it when done, and then resume your earlier
478
refactoring session.
479