Documentation/pretty-{formats,options}: better reference for "format:<string>"
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>
Nazri Ramliy committed
Jun 2, 2010 at 01:54 UTC
41e4d69fb82cd92bbc39accc9cb2be49b7597b5c
2 files changed
+5
-4
Documentation/pretty-formats.txt
+2
-2
@@ -76,9 +76,9 @@ displayed in full, regardless of whether --abbrev or
76
true parent commits, without taking grafts nor history
77
simplification into account.
78
79
-* 'format:'
79
+* 'format:<string>'
80
+
81
-The 'format:' format allows you to specify which information
81
+The 'format:<string>' format allows you to specify which information
82
you want to show. It works a little bit like printf format,
83
with the notable exception that you get a newline with '%n'
84
instead of '\n'.
Documentation/pretty-options.txt
+3
-2
@@ -3,8 +3,9 @@
3
4
Pretty-print the contents of the commit logs in a given format,
5
where '<format>' can be one of 'oneline', 'short', 'medium',
6
- 'full', 'fuller', 'email', 'raw' and 'format:<string>'.
7
- When omitted, the format defaults to 'medium'.
6
+ 'full', 'fuller', 'email', 'raw' and 'format:<string>'. See
7
+ the "PRETTY FORMATS" section for some additional details for each
8
+ format. When omitted, the format defaults to 'medium'.
9
+
10
Note: you can specify the default pretty format in the repository
11
configuration (see linkgit:git-config[1]).