* Bug: manpage for `git ls-files` uses <file> instead of <pathspec>
@ 2018-10-11 3:20 Lily Ballard
2018-10-13 8:03 ` Junio C Hamano
0 siblings, 1 reply; 2+ messages in thread
From: Lily Ballard @ 2018-10-11 3:20 UTC (permalink / raw)
To: git
`git ls-files` takes zero or more <pathspec>s, but the manpage (and the `-h` output) lists it as taking zero or more <file>s instead. This is confusing as <file> is documented in `man git` as a filename, without any magic. But a pathspec has a lot of special handling. The gitglossary entry for pathspec does say that `git ls-files` takes it, but nobody is going to know to look there in the first place if they look at `git ls-files` and see that it takes files.
I haven’t checked any other commands that the glossary lists as taking pathspecs (except `git add`, which does properly list it as taking pathspecs), so I don’t know if any of the other commands incorrectly list themselves as taking files when they take pathspecs.
git version 2.19.1.
-Lily Ballard
^ permalink raw reply [flat|nested] 2+ messages in thread
* Re: Bug: manpage for `git ls-files` uses <file> instead of <pathspec>
2018-10-11 3:20 Bug: manpage for `git ls-files` uses <file> instead of <pathspec> Lily Ballard
@ 2018-10-13 8:03 ` Junio C Hamano
0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2018-10-13 8:03 UTC (permalink / raw)
To: Lily Ballard; +Cc: git
Lily Ballard <lily@sb.org> writes:
> I haven’t checked any other commands that the glossary lists as
> taking pathspecs (except `git add`, which does properly list it as
> taking pathspecs), so I don’t know if any of the other commands
> incorrectly list themselves as taking files when they take
> pathspecs.
I do not offhand think of a command that only takes pathname,
including "ls-files". New users would think "git cmd README" is
taking a single filename "README", and "ls-files" doc uses "file"
in a misguided attempt to be "newbie friendly", but it always has
used that "README" string as a pattern to match paths against.
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2018-10-13 8:03 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2018-10-11 3:20 Bug: manpage for `git ls-files` uses <file> instead of <pathspec> Lily Ballard
2018-10-13 8:03 ` Junio C Hamano
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).