Re: [PATCH v2 5/6] doc: commit: unify <pathspec> description

From: Alexandr Miloslavskiy <alexandr.miloslavskiy@syntevo.com>
Date: Nov 19, 2019, 17:02 UTC
Message-ID: <1d3cb1f6-1537-0619-6484-9bbd187c67fe@syntevo.com>
In-Reply-To: <xmqqk17wxuev.fsf@gitster-ct.c.googlers.com>

On 19.11.2019 7:16, Junio C Hamano wrote:

Show 12 quoted lines

>> +For more details about the <pathspec> syntax, see the 'pathspec' entry
>> +in linkgit:gitglossary[7].
> 
> What you added in [PATCH 3/6] (git reset doc) sends a slightly
> different message, i.e.
> 
>      The <pathspec> is used to limit the paths affected by the operation
>      (see the entry for 'pathspec' in linkgit:gitglossary[7] for more details).
> 
> and I think that was more appropriate than what we see here.  You
> are referring your readers to the glossary entry not just for the
> syntax but also the entire concept of <pathspec>.

This has shown me that I didn't synchronize docs enough. I have studied docs for other commands and found out that most of them list <pathspec> in a separate paragraph under options.

I find it very reasonable, because that's where I would normally expect it as a reader, together with other options.

So I adjusted 'git-reset' docs to also list <pathspec> under options.