From: Jeff King <peff@peff.net>
To: Francis Irving <francis@scraperwiki.com>
Cc: git@vger.kernel.org
Subject: Re: Documentation for "git log --all" incorrect
Date: Wed, 29 Oct 2014 15:54:45 -0400 [thread overview]
Message-ID: <20141029195445.GA27413@peff.net> (raw)
In-Reply-To: <20141029115134.GA33348@bat.dot-bit.org>
On Wed, Oct 29, 2014 at 11:51:34AM +0000, Francis Irving wrote:
> The help for "git log --all" says:
>
> --all
> Pretend as if all the refs in refs/ are listed on
> the command line as <commit>.
>
> This makes no sense, as <commit> is not a documented valid command line
> parameter. These are the documented parameters:
>
> SYNOPSIS
> git log [<options>] [<revision range>] [[--] <path>...]
>
> Even if it means <revision range>, which is my best guess, it still
> makes no sense as <revision range> cannot be a list of many refs.
The text for "--all" comes from rev-list-options.txt, which is included
in git-rev-list.txt and git-log.txt. It makes sense in the former but
not the latter. One fix would be to use "<commit>" in the synopsis for
git-log. But I think it would probably be OK to just drop the "as
<commit>" part of the --all text (and other related options need this,
too). It seems pretty clear to me without it.
Do you want to try your hand at a patch?
-Peff
prev parent reply other threads:[~2014-10-29 19:54 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-10-29 11:51 Documentation for "git log --all" incorrect Francis Irving
2014-10-29 19:54 ` Jeff King [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20141029195445.GA27413@peff.net \
--to=peff@peff.net \
--cc=francis@scraperwiki.com \
--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.
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 NNTP newsgroup(s).