From: Felipe Contreras <felipe.contreras@gmail.com>
To: Jeff King <peff@peff.net>, Felipe Contreras <felipe.contreras@gmail.com>
Cc: "Junio C Hamano" <gitster@pobox.com>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
git@vger.kernel.org
Subject: Re: Man pages have colors? A deep dive into groff
Date: Tue, 18 May 2021 08:21:26 -0500 [thread overview]
Message-ID: <60a3bf5624cbc_15198720876@natae.notmuch> (raw)
In-Reply-To: <YKNptH9DL6pe18Dk@coredump.intra.peff.net>
Jeff King wrote:
> On Mon, May 17, 2021 at 11:27:23PM -0500, Felipe Contreras wrote:
>
> > > So in short, the color.pager is about "is the pager capable of
> > > colors?"
> >
> > That's not the case.
> >
> > Even the documentation says so:
> >
> > color.pager::
> > A boolean to enable/disable colored output when the pager is in
> > use (default is true).
>
> I think that documentation misses the reason you'd want to use it.
> Likewise, the commit message introducing it (aa086eb813d) sucks,
Well, it was 2006. Many of the best practices of today were not followed
back then.
> but the
> motivation (from [0]) was:
>
> When I use a pager that escapes the escape character or highlights the
> content itself the output of git diff without the pager should have
> colors but not with the pager. For example using git diff with a
> pathspec is quite short most of the time. For git diff I have to
> enable paging manually and run git diff | $PAGER usually but git log
> uses the pager automatically and should not use colors with it.
This is aligned with what I said: the uswer wants to disable colors when
using a pager.
Yes, in this instance it's because the pager doesn't support colors, but
that's not always necessarily so. A person with sight problems may use
less (perfectly capable of colors), but yet not want to exercise that
capability.
It's still a preference.
> For a more concrete example, my pager _does_ understand colors, and I
> would not want to set pager.color to "false" (because then "git log",
> etc, would not show me any colors). But I don't like the man colors you
> are suggesting.
You can change them in your environment.
> I want to be able to turn them off by setting "color.man" or similar
> to false, not by disabling color for everything that is paged.
Sure, for that particular case it does make sense. I'll add that.
> So color.pager being true is _necessary_ for showing colors in paged
> outputs, but by itself is not sufficient. We have other per-context
> color options (color.diff, color.branch, and so on).
>
> And so likewise, we would want to avoid turning on colors if the user
> has set color.pager=false. Usually this is done automatically because
> want_color() checks, which knows if we are using the pager or not. But
> if we are going to call out to "man" which will invoke another pager,
> that caller would have to check pager_use_color themselves (it's yet
> another question of whether "the pager can handle color" applies equally
> to the pager that Git will run versus the one that man will run).
Yes, but we still need to check pager_use_color.
Except... Maybe a user has GIT_PAGER set to a colorless pager, and
MANPAGER to something fancier, in which case color.pager should be
ignored. But that's probably a corner-case nobody is ever going to hit.
Anyway, I've sent an update version with color.man.
--
Felipe Contreras
next prev parent reply other threads:[~2021-05-18 13:21 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-15 22:10 Man pages have colors? A deep dive into groff Felipe Contreras
2021-05-17 16:48 ` Ævar Arnfjörð Bjarmason
2021-05-17 19:28 ` Junio C Hamano
2021-05-17 22:44 ` Felipe Contreras
2021-05-17 22:54 ` Randall S. Becker
2021-05-17 23:33 ` Felipe Contreras
2021-05-18 1:27 ` Junio C Hamano
2021-05-18 4:27 ` Felipe Contreras
2021-05-18 7:16 ` Jeff King
2021-05-18 13:21 ` Felipe Contreras [this message]
2021-05-18 14:27 ` Junio C Hamano
2021-05-18 1:28 ` brian m. carlson
2021-05-18 2:12 ` Junio C Hamano
2021-05-18 4:35 ` Felipe Contreras
2021-05-18 4:31 ` Felipe Contreras
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=60a3bf5624cbc_15198720876@natae.notmuch \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).