undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Documentation/pretty-{formats,options}: better reference for "format:<string>"

Browse Source 
In "git help log" (and friends) it's not easy to find the possible
placeholder for <string> for the "--pretty=format:<string>" option
to git log.

This patch makes the placeholder easier to find by adding a reference
to the "PRETTY FORMATS" section and repeating the "format:<string>"
phrase.

Signed-off-by: Nazri Ramliy <ayiehere@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Nazri Ramliy 2010-06-02 01:54:46 +08:00 committed by Junio C Hamano
parent 6774e2bf08
commit 41e4d69fb8
2 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/pretty-formats.txt
View File

@ -76,9 +76,9 @@ displayed in full, regardless of whether --abbrev or
true parent commits, without taking grafts nor history true parent commits, without taking grafts nor history
simplification into account. simplification into account.
* 'format:' * 'format:<string>'
+ +
The 'format:' format allows you to specify which information The 'format:<string>' format allows you to specify which information
you want to show. It works a little bit like printf format, you want to show. It works a little bit like printf format,
with the notable exception that you get a newline with '%n' with the notable exception that you get a newline with '%n'
instead of '\n'. instead of '\n'.

5
Documentation/pretty-options.txt
View File

@ -3,8 +3,9 @@
Pretty-print the contents of the commit logs in a given format, Pretty-print the contents of the commit logs in a given format,
where '<format>' can be one of 'oneline', 'short', 'medium', where '<format>' can be one of 'oneline', 'short', 'medium',
'full', 'fuller', 'email', 'raw' and 'format:<string>'. 'full', 'fuller', 'email', 'raw' and 'format:<string>'. See
When omitted, the format defaults to 'medium'. the "PRETTY FORMATS" section for some additional details for each
format. When omitted, the format defaults to 'medium'.
+ +
Note: you can specify the default pretty format in the repository Note: you can specify the default pretty format in the repository
configuration (see linkgit:git-config[1]). configuration (see linkgit:git-config[1]).