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

From: Junio C Hamano <gitster@pobox.com>
Date: Nov 19, 2019, 06:16 UTC
Message-ID: <xmqqk17wxuev.fsf@gitster-ct.c.googlers.com>
In-Reply-To: <20c4495fd31110c56cca84385bee6d1ab4a6f33e.1573055478.git.gitgitgadget@gmail.com>

"Alexandr Miloslavskiy via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 8 quoted lines

> +<pathspec>...::
> +	When pathspec is given on the command line, commit the contents of
> +	the files that match the pathspec without recording the changes
> +	already added to the index. The contents of these files are also
> +	staged for the next commit on top of what have been staged before.
> ++
> +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>.

IOW, it would be needed to drop "syntax" from "about the <pathspec> syntax" from here to match the update to "git reset" documentation.

Thanks.