diff options
| author | Sam Bostock <sam.bostock@shopify.com> | 2026-01-28 05:39:45 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2026-01-28 15:25:33 -0800 |
| commit | 6f5ca70580444e61231ad33de0aac81d2420d523 (patch) | |
| tree | 78c02ee2da7e41445388f678270a2cb0a191f17e /Documentation/git-worktree.adoc | |
| parent | 9a2fb147f2c61d0cab52c883e7e26f5b7948e3ed (diff) | |
| download | git-6f5ca70580444e61231ad33de0aac81d2420d523.tar.xz | |
worktree: clarify that --expire only affects missing worktrees
The --expire option for "git worktree list" and "git worktree prune"
only affects worktrees whose working directory path no longer exists.
The help text did not make this clear, and the documentation
inconsistently used "unused" for prune but "missing" for list.
Update the help text and documentation to consistently describe these
as "missing worktrees", and use "prune" instead of "expire" when
describing the effect on missing worktrees since the terminology is
clearer.
While at it, expand the description of the "prune" subcommand itself
to better explain what it does and when to use it, as suggested by
Junio.
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Helped-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Sam Bostock <sam@sambostock.ca>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-worktree.adoc')
| -rw-r--r-- | Documentation/git-worktree.adoc | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/Documentation/git-worktree.adoc b/Documentation/git-worktree.adoc index f272f79783..22ef37ec02 100644 --- a/Documentation/git-worktree.adoc +++ b/Documentation/git-worktree.adoc @@ -131,7 +131,13 @@ with linked worktrees if you move the main worktree manually.) `prune`:: -Prune worktree information in `$GIT_DIR/worktrees`. +Remove worktree information in `$GIT_DIR/worktrees` for worktrees +whose working trees are missing. Useful after manually removing +a working tree that is no longer needed (but use "git worktree +remove" next time you want to do so). Also, if you _moved_ a +working tree elsewhere causing the worktree information to become +dangling, see "git worktree repair" to reconnect the worktree to +the new working tree location. `remove`:: @@ -271,7 +277,7 @@ mismatch, even if the links are correct. With `list`, output additional information about worktrees (see below). `--expire <time>`:: - With `prune`, only expire unused worktrees older than _<time>_. + With `prune`, only prune missing worktrees if older than _<time>_. + With `list`, annotate missing worktrees as prunable if they are older than _<time>_. |