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>
This commit is contained in:
martin f. krafft 2008-09-30 21:57:50 +02:00 committed by Shawn O. Pearce
parent 5d6b3a9ef8
commit b1524ee0f3

View file

@ -8,7 +8,7 @@ git-log - Show commit logs
SYNOPSIS SYNOPSIS
-------- --------
'git log' <option>... 'git log' [<options>] [<since>..<until>] [[\--] <path>...]
DESCRIPTION DESCRIPTION
----------- -----------
@ -57,8 +57,11 @@ include::diff-options.txt[]
Note that only message is considered, if also a diff is shown Note that only message is considered, if also a diff is shown
its size is not included. its size is not included.
<path>...:: [\--] <path>...::
Show only commits that affect any of the specified paths. 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[] include::rev-list-options.txt[]