Re: [PATCH 2/2] git-worktree.txt: add missing `-v` to synopsis for `worktree list`
flat view
From: Ævar Arnfjörð Bjarmason <hidden>
Date: 2021-12-03 09:15:47
On Thu, Dec 02 2021, Eric Sunshine wrote:
quoted hunk ↗ jump to hunk
When verbose mode was added to `git worktree list` by 076b444a62 (worktree: teach `list` verbose mode, 2021-01-27), although the documentation was updated to reflect the new functionality, the synopsis was overlooked. Correct this minor oversight. Signed-off-by: Eric Sunshine <redacted> --- Documentation/git-worktree.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)diff --git a/Documentation/git-worktree.txt b/Documentation/git-worktree.txt index 8a7cbdd19c..9e862fbcf7 100644 --- a/Documentation/git-worktree.txt +++ b/Documentation/git-worktree.txt@@ -10,7 +10,7 @@ SYNOPSIS -------- [verse] 'git worktree add' [-f] [--detach] [--checkout] [--lock [--reason <string>]] [-b <new-branch>] <path> [<commit-ish>] -'git worktree list' [--porcelain] +'git worktree list' [-v | --porcelain] 'git worktree lock' [--reason <string>] <worktree> 'git worktree move' <worktree> <new-path> 'git worktree prune' [-n] [-v] [--expire <expire>]
Looks good!
Aside: I've been thinking of hacking something up to just change all
these "[verse]" bits in the *.txt source to:
[verse]
$(git worktree -h)
And then have the doc build process pick that up, run 'git $name -h', do
some light search/replacement (e.g. "$cmd" to "'$cmd'") and build the
docs like that.
Seems far preferrable to dual-maintaining all of these forever.
But in the meantime this small fix is obviously correct.