git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Lily Ballard <lily@sb.org>
To: git@vger.kernel.org
Subject: Bug: manpage for `git ls-files` uses <file> instead of <pathspec>
Date: Wed, 10 Oct 2018 20:20:01 -0700	[thread overview]
Message-ID: <1539228001.1758106.1538051752.20CB6C51@webmail.messagingengine.com> (raw)

`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

             reply	other threads:[~2018-10-11  3:20 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-11  3:20 Lily Ballard [this message]
2018-10-13  8:03 ` Bug: manpage for `git ls-files` uses <file> instead of <pathspec> Junio C Hamano

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

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1539228001.1758106.1538051752.20CB6C51@webmail.messagingengine.com \
    --to=lily@sb.org \
    --cc=git@vger.kernel.org \
    /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. 
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).