diff options
| author |  Andreas Heiduk <asheiduk@gmail.com> | 2017-06-24 09:22:58 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2017-06-24 11:23:55 -0700 |
| commit | 8592c95cdfb476dff5c9e18c185289927601236d (patch) | |
| tree | f45886f643ce39c5f2382128583f8b9422ce641e | |
| parent | Git 2.12.3 (diff) | |
| download | tgif-8592c95cdfb476dff5c9e18c185289927601236d.tar.xz | |
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>
| -rw-r--r-- | Documentation/pretty-formats.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt index 47b286b33e..a4fa887683 100644 --- a/Documentation/pretty-formats.txt +++ b/Documentation/pretty-formats.txt @@ -174,11 +174,12 @@ endif::git-rev-list[] - '%Creset': reset color - '%C(...)': color specification, as described under Values in the "CONFIGURATION FILE" section of linkgit:git-config[1]; - adding `auto,` at the beginning will emit color only when colors are - enabled for log output (by `color.diff`, `color.ui`, or `--color`, and - respecting the `auto` settings of the former if we are going to a - terminal). `auto` alone (i.e. `%C(auto)`) will turn on auto coloring - on the next placeholders until the color is switched again. + adding `auto,` at the beginning (e.g. `%C(auto,red)`) will emit + color only when colors are enabled for log output (by `color.diff`, + `color.ui`, or `--color`, and respecting the `auto` settings of the + former if we are going to a terminal). `auto` alone (i.e. + `%C(auto)`) will turn on auto coloring on the next placeholders + until the color is switched again. - '%m': left (`<`), right (`>`) or boundary (`-`) mark - '%n': newline - '%%': a raw '%' |