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>
Jeff King committed
May 19, 2021 at 05:17 UTC
a84216c68435f545de38d69c771a6f2ade480394
1 file changed
+3
-2
Documentation/config/color.txt
+3
-2
@@ -127,8 +127,9 @@ color.interactive.<slot>::
127
interactive commands.
128
129
color.pager::
130
- A boolean to enable/disable colored output when the pager is in
131
- use (default is true).
130
+ A boolean to specify whether `auto` color modes should colorize
131
+ output going to the pager. Defaults to true; set this to false
132
+ if your pager does not understand ANSI color codes.
133
134
color.push::
135
A boolean to enable/disable color in push errors. May be set to