Re: [PATCH 4/5] doc: commit: unify <pathspec> description
- From
- Alexandr Miloslavskiy <alexandr.miloslavskiy@syntevo.com>
- Date
- Nov 6, 2019, 15:56 UTC
- Message-ID
- <6cd64094-d229-ef96-86fd-e64accd759d4@syntevo.com>
- In-Reply-To
- <xmqq8sotvcar.fsf@gitster-ct.c.googlers.com>
I think I have implemented most suggestions in PatchV2. Thanks!
Show 10 quoted lines
> I am not sure if we want to repeat this all over the place. > > We do not say "For details about the <commit> syntax, see the > 'SPECIFYING REVISIONS' section of linkgit:git-rev-parse[1]" for > every command that takes <commit> from the command line. > > Is your urge to suggest adding this sentence coming from that you > are much more familiar with <commit> than <pathspec>? In other > words, if you were more familiar with Git, would you still be adding > this (and not corresponding one for <commit>)?
Commit is a well known term, dating from ancient times like CVS or even older.
Pathspec, however, is something new. When I pretend to be someone new to git, I see it this way: 1) Let's read "git commit" documentation 2) Where on this commandline do I put my filename?!
So yes, I would repeat it in every location that could be popular for new users.