Skip to content

Commit 41e4d69

Browse files
nazrigitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent 6774e2b commit 41e4d69

File tree

2 files changed

+5
-4
lines changed

2 files changed

+5
-4
lines changed

Documentation/pretty-formats.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,9 +76,9 @@ displayed in full, regardless of whether --abbrev or
7676
true parent commits, without taking grafts nor history
7777
simplification into account.
7878

79-
* 'format:'
79+
* 'format:<string>'
8080
+
81-
The 'format:' format allows you to specify which information
81+
The 'format:<string>' format allows you to specify which information
8282
you want to show. It works a little bit like printf format,
8383
with the notable exception that you get a newline with '%n'
8484
instead of '\n'.

Documentation/pretty-options.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,9 @@
33

44
Pretty-print the contents of the commit logs in a given format,
55
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'.
89
+
910
Note: you can specify the default pretty format in the repository
1011
configuration (see linkgit:git-config[1]).

0 commit comments

Comments
 (0)