summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormartin f. krafft <madduck@madduck.net>2008-09-30 19:57:50 (GMT)
committerShawn O. Pearce <spearce@spearce.org>2008-10-01 15:21:22 (GMT)
commitb1524ee0f3a34d76639090c988523550026cc98b (patch)
treeba2c59d940cd61ea3ba0e73b14b294a76f32d69b
parent5d6b3a9ef80a8bcd77b57ea14d4284b022b95a1f (diff)
downloadgit-b1524ee0f3a34d76639090c988523550026cc98b.zip
git-b1524ee0f3a34d76639090c988523550026cc98b.tar.gz
git-b1524ee0f3a34d76639090c988523550026cc98b.tar.bz2
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>
-rw-r--r--Documentation/git-log.txt9
1 files changed, 6 insertions, 3 deletions
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 0446bad..93a2a22 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[]