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>
martin f. krafft committed
Sep 30, 2008 at 21:57 UTC
b1524ee0f3a34d76639090c988523550026cc98b
1 file changed
+6
-3
Documentation/git-log.txt
+6
-3
@@ -8,7 +8,7 @@ git-log - Show commit logs
8
9
SYNOPSIS
10
--------
11
-'git log' <option>...
11
+'git log' [<options>] [<since>..<until>] [[\--] <path>...]
12
13
DESCRIPTION
14
-----------
@@ -57,8 +57,11 @@ include::diff-options.txt[]
57
Note that only message is considered, if also a diff is shown
58
its size is not included.
59
60
-<path>...::
61
- Show only commits that affect any of the specified paths.
60
+[\--] <path>...::
61
+ Show only commits that affect any of the specified paths. To
62
+ prevent confusion with options and branch names, paths may need
63
+ to be prefixed with "\-- " to separate them from options or
64
+ refnames.
65
66
67
include::rev-list-options.txt[]