From: martin f. krafft <madduck@madduck.net>
Date: Tue, 30 Sep 2008 19:57:50 +0000 (+0200)
Subject: Improve git-log documentation wrt file filters
X-Git-Tag: v1.6.0.3~47
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=b1524ee0f3a34d76639090c988523550026cc98b;p=git.git

Improve git-log documentation wrt file filters

The need for "--" in the git-log synopsis was previously unclear and
confusing. This patch makes it a little clearer.

Thanks to hyy <yiyihu@gmail.com> for his help.

[sp: Changed -- to \-- per prior commit e1ccf53.]

Signed-off-by: martin f. krafft <madduck@madduck.net>
Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
---

diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 0446bad7e..93a2a227c 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>...]
 
 DESCRIPTION
 -----------
@@ -57,8 +57,11 @@ 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 may need
+	to be prefixed with "\-- " to separate them from options or
+	refnames.
 
 
 include::rev-list-options.txt[]