diff options
| author | Jeff King <peff@peff.net> | 2021-05-19 09:17:09 (GMT) |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2021-05-20 06:37:10 (GMT) |
| commit | a84216c68435f545de38d69c771a6f2ade480394 (patch) | |
| tree | e7d0e522d5e7d99c1d4700b75ac5105a59ab4719 /Documentation/config/color.txt | |
| parent | 48bf2fa8bad054d66bd79c6ba903c89c704201f7 (diff) | |
| download | git-a84216c68435f545de38d69c771a6f2ade480394.zip git-a84216c68435f545de38d69c771a6f2ade480394.tar.gz git-a84216c68435f545de38d69c771a6f2ade480394.tar.bz2 | |
doc: explain the use of color.pager
The current documentation for color.pager is technically correct, but
slightly misleading and doesn't really clarify the purpose of the
variable. As explained in the original thread which added it:
https://lore.kernel.org/git/E1G6zPH-00062L-Je@moooo.ath.cx/
the point is to deal with pagers that don't understand colors. And hence it
being set to "true" is necessary for colorizing output to the pager, but
not sufficient by itself (you must also have enabled one of the other
color options, though note that these are set to "auto" by default these
days).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/config/color.txt')
| -rw-r--r-- | Documentation/config/color.txt | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/Documentation/config/color.txt b/Documentation/config/color.txt index d5daacb..e05d520 100644 --- a/Documentation/config/color.txt +++ b/Documentation/config/color.txt @@ -127,8 +127,9 @@ color.interactive.<slot>:: interactive commands. color.pager:: - A boolean to enable/disable colored output when the pager is in - use (default is true). + A boolean to specify whether `auto` color modes should colorize + output going to the pager. Defaults to true; set this to false + if your pager does not understand ANSI color codes. color.push:: A boolean to enable/disable color in push errors. May be set to |