From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: git@vger.kernel.org, Baruch Burstein <bmburstein@gmail.com>,
Randall Becker <rsbecker@nexbridge.com>,
Junio C Hamano <gitster@pobox.com>, Jeff King <peff@peff.net>,
Rafael Silva <rafaeloliveira.cs@gmail.com>
Subject: Re: [PATCH 2/2] git-worktree.txt: add missing `-v` to synopsis for `worktree list`
Date: Fri, 03 Dec 2021 10:13:49 +0100 [thread overview]
Message-ID: <211203.86k0gmt5fl.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <20211203034420.47447-3-sunshine@sunshineco.com>
On Thu, Dec 02 2021, Eric Sunshine wrote:
> 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 <sunshine@sunshineco.com>
> ---
> 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.
next prev parent reply other threads:[~2021-12-03 9:15 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-12-03 3:44 [PATCH 0/2] worktree: fix incorrectly-ordered messages on Windows Eric Sunshine
2021-12-03 3:44 ` [PATCH 1/2] worktree: send "chatty" messages to stderr Eric Sunshine
2021-12-03 9:17 ` Ævar Arnfjörð Bjarmason
2021-12-03 13:07 ` Eric Sunshine
2021-12-03 3:44 ` [PATCH 2/2] git-worktree.txt: add missing `-v` to synopsis for `worktree list` Eric Sunshine
2021-12-03 9:13 ` Ævar Arnfjörð Bjarmason [this message]
2021-12-03 12:48 ` Eric Sunshine
2021-12-03 14:57 ` Ævar Arnfjörð Bjarmason
2021-12-03 15:52 ` Jeff King
2021-12-05 9:12 ` Junio C Hamano
2021-12-06 13:34 ` Eric Sunshine
2021-12-06 15:06 ` Ævar Arnfjörð Bjarmason
2021-12-06 17:53 ` Junio C Hamano
2021-12-11 22:25 ` Rafael Silva
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=211203.86k0gmt5fl.gmgdl@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=bmburstein@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=rafaeloliveira.cs@gmail.com \
--cc=rsbecker@nexbridge.com \
--cc=sunshine@sunshineco.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.