doc: explain the use of color.pager
authorJeff King <peff@peff.net>
Wed, 19 May 2021 09:17:09 +0000 (05:17 -0400)
committerJunio C Hamano <gitster@pobox.com>
Thu, 20 May 2021 06:37:10 +0000 (15:37 +0900)
commita84216c68435f545de38d69c771a6f2ade480394
treee7d0e522d5e7d99c1d4700b75ac5105a59ab4719
parent48bf2fa8bad054d66bd79c6ba903c89c704201f7
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>
Documentation/config/color.txt