Skip to content

Commit 5e22e21

Browse files
committed
Merge branch 'maint'
* maint: Improve git-log documentation wrt file filters Documentation: remove '\' in front of short options
2 parents 8b745e3 + b1524ee commit 5e22e21

File tree

3 files changed

+12
-9
lines changed

3 files changed

+12
-9
lines changed

Documentation/git-log.txt

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ git-log - Show commit logs
88

99
SYNOPSIS
1010
--------
11-
'git log' <option>...
11+
'git log' [<options>] [<since>..<until>] [[\--] <path>...]
1212

1313
DESCRIPTION
1414
-----------
@@ -57,8 +57,11 @@ include::diff-options.txt[]
5757
Note that only message is considered, if also a diff is shown
5858
its size is not included.
5959

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

6366

6467
include::rev-list-options.txt[]

Documentation/git-rev-list.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ SYNOPSIS
3232
[ \--cherry-pick ]
3333
[ \--encoding[=<encoding>] ]
3434
[ \--(author|committer|grep)=<pattern> ]
35-
[ \--regexp-ignore-case | \-i ]
36-
[ \--extended-regexp | \-E ]
37-
[ \--fixed-strings | \-F ]
35+
[ \--regexp-ignore-case | -i ]
36+
[ \--extended-regexp | -E ]
37+
[ \--fixed-strings | -F ]
3838
[ \--date={local|relative|default|iso|rfc|short} ]
3939
[ [\--objects | \--objects-edge] [ \--unpacked ] ]
4040
[ \--pretty | \--header ]

Documentation/githooks.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -87,12 +87,12 @@ default log message, and before the editor is started.
8787

8888
It takes one to three parameters. The first is the name of the file
8989
that the commit log message. The second is the source of the commit
90-
message, and can be: `message` (if a `\-m` or `\-F` option was
91-
given); `template` (if a `\-t` option was given or the
90+
message, and can be: `message` (if a `-m` or `-F` option was
91+
given); `template` (if a `-t` option was given or the
9292
configuration option `commit.template` is set); `merge` (if the
9393
commit is a merge or a `.git/MERGE_MSG` file exists); `squash`
9494
(if a `.git/SQUASH_MSG` file exists); or `commit`, followed by
95-
a commit SHA1 (if a `\-c`, `\-C` or `\--amend` option was given).
95+
a commit SHA1 (if a `-c`, `-C` or `\--amend` option was given).
9696

9797
If the exit status is non-zero, 'git-commit' will abort.
9898

0 commit comments

Comments
 (0)