From: "Shawn O. Pearce" <spearce@spearce.org>
To: "martin f. krafft" <madduck@madduck.net>
Cc: git@vger.kernel.org
Subject: Re: [PATCH] Improve git-log documentation wrt file filters
Date: Tue, 30 Sep 2008 12:25:53 -0700 [thread overview]
Message-ID: <20080930192553.GI21310@spearce.org> (raw)
In-Reply-To: <1222785372-32336-1-git-send-email-madduck@madduck.net>
"martin f. krafft" <madduck@madduck.net> wrote:
> The need for "--" in the git-log synopsis was previously unclear and
> confusing. This patch makes it a little clearer.
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index 0446bad..b7409f8 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -8,7 +8,7 @@ git-log - Show commit logs
>
> SYNOPSIS
> --------
> -'git log' <option>...
> +'git log' [<options>] [<since>..<until>] [[--] <path>...]
This part is really useful.
> DESCRIPTION
> -----------
> @@ -57,8 +57,10 @@ include::diff-options.txt[]
> Note that only message is considered, if also a diff is shown
> its size is not included.
>
> -<path>...::
> - Show only commits that affect any of the specified paths.
> +-- <path>...::
> + Show only commits that affect any of the specified paths. To
> + prevent confusion with options and branch names, paths should be
> + prefixed with "-- " to separate them from options or refnames.
Indentation here looks wrong, especially on the last two lines.
I'm also not sure we want to say "-- <path>" in the header for
this section. The -- is optional but I'm reading this as though it
is required. Maybe "... paths can be prefixed with -- ..." instead?
--
Shawn.
next prev parent reply other threads:[~2008-09-30 19:27 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-09-30 14:36 [PATCH] Improve git-log documentation wrt file filters martin f. krafft
2008-09-30 19:25 ` Shawn O. Pearce [this message]
2008-09-30 19:57 ` martin f. krafft
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=20080930192553.GI21310@spearce.org \
--to=spearce@spearce.org \
--cc=git@vger.kernel.org \
--cc=madduck@madduck.net \
/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).