Merge branch 'maint'

* maint:
  Improve git-log documentation wrt file filters
  Documentation: remove '\' in front of short options
maint
Shawn O. Pearce 2008-10-01 08:56:36 -07:00
commit 5e22e21769
3 changed files with 12 additions and 9 deletions

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[]

View File

@ -32,9 +32,9 @@ SYNOPSIS
[ \--cherry-pick ] [ \--cherry-pick ]
[ \--encoding[=<encoding>] ] [ \--encoding[=<encoding>] ]
[ \--(author|committer|grep)=<pattern> ] [ \--(author|committer|grep)=<pattern> ]
[ \--regexp-ignore-case | \-i ] [ \--regexp-ignore-case | -i ]
[ \--extended-regexp | \-E ] [ \--extended-regexp | -E ]
[ \--fixed-strings | \-F ] [ \--fixed-strings | -F ]
[ \--date={local|relative|default|iso|rfc|short} ] [ \--date={local|relative|default|iso|rfc|short} ]
[ [\--objects | \--objects-edge] [ \--unpacked ] ] [ [\--objects | \--objects-edge] [ \--unpacked ] ]
[ \--pretty | \--header ] [ \--pretty | \--header ]

View File

@ -87,12 +87,12 @@ default log message, and before the editor is started.


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


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