doc: clarify syntax for %C(auto,...) in pretty formats
The manual correctly describes the syntax with `auto,` but the trailing `,` is hard to spot in a terminal. The HTML format does not have this problem. Adding an example helps both worlds. Signed-off-by: Andreas Heiduk <asheiduk@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Andreas Heiduk committed
Jun 24, 2017 at 09:22 UTC
8592c95cdfb476dff5c9e18c185289927601236d
1 file changed
+6
-5
Documentation/pretty-formats.txt
+6
-5
@@ -174,11 +174,12 @@ endif::git-rev-list[]
174
- '%Creset': reset color
175
- '%C(...)': color specification, as described under Values in the
176
"CONFIGURATION FILE" section of linkgit:git-config[1];
177
- adding `auto,` at the beginning will emit color only when colors are
178
- enabled for log output (by `color.diff`, `color.ui`, or `--color`, and
179
- respecting the `auto` settings of the former if we are going to a
180
- terminal). `auto` alone (i.e. `%C(auto)`) will turn on auto coloring
181
- on the next placeholders until the color is switched again.
177
+ adding `auto,` at the beginning (e.g. `%C(auto,red)`) will emit
178
+ color only when colors are enabled for log output (by `color.diff`,
179
+ `color.ui`, or `--color`, and respecting the `auto` settings of the
180
+ former if we are going to a terminal). `auto` alone (i.e.
181
+ `%C(auto)`) will turn on auto coloring on the next placeholders
182
+ until the color is switched again.
183
- '%m': left (`<`), right (`>`) or boundary (`-`) mark
184
- '%n': newline
185
- '%%': a raw '%'