Re: [PATCH] Improve git-log documentation wrt file filters

From: Shawn O. Pearce <spearce@spearce.org>
Date: Sep 30, 2008, 19:25 UTC
Message-ID: <20080930192553.GI21310@spearce.org>
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.

Show 10 quoted lines

> 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.

Show 12 quoted lines

>  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.