public inbox for git@vger.kernel.org
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: Britton Leo Kerin <britton.kerin@gmail.com>,
	 git@vger.kernel.org, Britton L Kerin <britton.kergin@gmail.com>
Subject: Re: [PATCH 1/1] doc: use singular form of repeatable path arg
Date: Wed, 27 Dec 2023 16:10:50 -0800	[thread overview]
Message-ID: <xmqq5y0jkwz9.fsf@gitster.g> (raw)
In-Reply-To: <CAPig+cShsSSd-jpvSW_sq3-R++zjtHU-m2PmTsz-Nx9YVRStug@mail.gmail.com> (Eric Sunshine's message of "Wed, 27 Dec 2023 17:29:20 -0500")

Eric Sunshine <sunshine@sunshineco.com> writes:

> On Wed, Dec 27, 2023 at 3:55 PM Britton Leo Kerin
> <britton.kerin@gmail.com> wrote:
>> This is more correct because the <path>... doc syntax already indicates
>> that the arg is "array-type".  It's how other tools do it.  Finally, the
>> later document text mentions 'path' arguments, while it doesn't mention
>> 'paths'.
>
> Yep, makes sense.
>
>> Signed-off-by: Britton L Kerin <britton.kergin@gmail.com>

Micronit.  This should be identical to how From: line identifies the
author.  s/L/Leo/ should be sufficient, I presume?

>> ---
>> diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
>> @@ -17,7 +17,7 @@ The command takes various subcommands, and different options depending
>>   git bisect start [--term-(new|bad)=<term-new> --term-(old|good)=<term-old>]
>> -                 [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]
>> +                 [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<path>...]
>
> Looking good.
>
> In builtin/bisect.c, the "usage" string says "[<pathspec>...]" rather
> than "[<path>...]". Perhaps it makes sense to unify these?

Yup, and that would be a good thing to do in a single patch, and
also it would be a good place to stop.  Further clean-up you
suggested below are very much worth doing, but it probably is good
to leave out of this single focused fix we are reviewing here and
instead be done as separate patch(es).

Thanks.

> Also, there are a few more documentation files that could use the
> "<paths>" to "<path>..." fixup (though not always in the synopsis). A
> 'grep' indicates that git-checkout.txt, git-diff.txt, and
> git-rev-list-options.txt also mention "<paths>". Those may be outside
> the scope of this patch, although they could easily be included, as
> well, or made part of a patch series if you feel inclined.

      reply	other threads:[~2023-12-28  0:10 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <20231227205340.9886-1-britton.kerin@gmail.com>
2023-12-27 20:53 ` [PATCH 1/1] doc: use singular form of repeatable path arg Britton Leo Kerin
2023-12-27 22:29   ` Eric Sunshine
2023-12-28  0:10     ` Junio C Hamano [this message]

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=xmqq5y0jkwz9.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=britton.kergin@gmail.com \
    --cc=britton.kerin@gmail.com \
    --cc=git@vger.kernel.org \
    --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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox