From: Jeff King <peff@peff.net>
To: git@vger.kernel.org
Cc: Simon Courtois <scourtois@cubyx.fr>, Junio C Hamano <gitster@pobox.com>
Subject: [PATCH v2 2/7] doc: refactor description of color format
Date: Thu, 23 Jun 2016 13:32:30 -0400 [thread overview]
Message-ID: <20160623173229.GB15774@sigill.intra.peff.net> (raw)
In-Reply-To: <20160623173048.GA19923@sigill.intra.peff.net>
This is a general cleanup of the description of colors in
git-config, mostly to address inaccuracies and confusion
that had grown over time:
- you can have many attributes, not just one
- the discussion flip-flopped between colors and
attributes; now we discuss everything about colors, then
everything about attributes
- many concepts were lumped into the first paragraph,
making it hard to read, and especially to find the
actual lists of colors and attributes. I stopped short
of breaking those out into their own lists, as it seemed
like an excessive use of vertical screen real estate.
- we introduced negated attributes, but then the next
paragraph basically explains how each item starts off
with no attributes. So why would one need negated
attributes? We now explain.
- minor typo, language, and typography fixes
Signed-off-by: Jeff King <peff@peff.net>
---
Documentation/config.txt | 47 ++++++++++++++++++++++++++---------------------
1 file changed, 26 insertions(+), 21 deletions(-)
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 58673cf..f8460d4 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -150,27 +150,32 @@ integer::
1024", "by 1024x1024", etc.
color::
- The value for a variables that takes a color is a list of
- colors (at most two) and attributes (at most one), separated
- by spaces. The colors accepted are `normal`, `black`,
- `red`, `green`, `yellow`, `blue`, `magenta`, `cyan` and
- `white`; the attributes are `bold`, `dim`, `ul`, `blink` and
- `reverse`. The first color given is the foreground; the
- second is the background. The position of the attribute, if
- any, doesn't matter. Attributes may be turned off specifically
- by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
-+
-Colors (foreground and background) may also be given as numbers between
-0 and 255; these use ANSI 256-color mode (but note that not all
-terminals may support this). If your terminal supports it, you may also
-specify 24-bit RGB values as hex, like `#ff0ab3`.
-+
-The attributes are meant to be reset at the beginning of each item
-in the colored output, so setting color.decorate.branch to `black`
-will paint that branch name in a plain `black`, even if the previous
-thing on the same output line (e.g. opening parenthesis before the
-list of branch names in `log --decorate` output) is set to be
-painted with `bold` or some other attribute.
+ The value for a variable that takes a color is a list of
+ colors (at most two, one for foreground and one for background)
+ and attributes (as many as you want), separated by spaces.
++
+The basic colors accepted are `normal`, `black`, `red`, `green`, `yellow`,
+`blue`, `magenta`, `cyan` and `white`. The first color given is the
+foreground; the second is the background.
++
+Colors may also be given as numbers between 0 and 255; these use ANSI
+256-color mode (but note that not all terminals may support this). If
+your terminal supports it, you may also specify 24-bit RGB values as
+hex, like `#ff0ab3`.
++
+The accepted attributes are `bold`, `dim`, `ul`, `blink`, and `reverse`.
+The position of any attributes with respect to the colors (before, after,
+or in between), doesn't matter. Specific attributes may be turned off
+by prefixing them with `no` (e.g., `noreverse`, `noul`, etc).
++
+For git's pre-defined color slots, the attributes are meant to be reset
+at the beginning of each item in the colored output. So setting
+`color.decorate.branch` to `black` will paint that branch name in a
+plain `black`, even if the previous thing on the same output line (e.g.
+opening parenthesis before the list of branch names in `log --decorate`
+output) is set to be painted with `bold` or some other attribute.
+However, custom log formats may do more complicated and layered
+coloring, and the negated forms may be useful there.
pathname::
A variable that takes a pathname value can be given a
--
2.9.0.209.g845fbc1
next prev parent reply other threads:[~2016-06-23 17:32 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-06-23 11:54 Italics formatting Simon Courtois
2016-06-23 13:08 ` [PATCH 0/2] more ANSI attributes Jeff King
2016-06-23 13:09 ` [PATCH 1/2] color: fix max-size comment Jeff King
2016-06-23 13:10 ` [PATCH 2/2] color: support "italic" attribute Jeff King
2016-06-23 13:57 ` Simon Courtois
2016-06-23 16:46 ` Junio C Hamano
2016-06-23 16:47 ` Jeff King
2016-06-23 17:30 ` [PATCH v2 0/7] more ANSI attributes Jeff King
2016-06-23 17:31 ` [PATCH v2 1/7] color: fix max-size comment Jeff King
2016-06-23 17:32 ` Jeff King [this message]
2016-06-23 17:33 ` [PATCH v2 3/7] add skip_prefix_mem helper Jeff King
2016-06-23 17:38 ` [PATCH v2 4/7] color: refactor parse_attr Jeff King
2016-06-23 17:38 ` [PATCH v2 5/7] color: allow "no-" for negating attributes Jeff King
2016-06-23 17:39 ` [PATCH v2 6/7] color: support "italic" attribute Jeff King
2016-06-23 18:34 ` Junio C Hamano
2016-06-23 18:36 ` Jeff King
2016-06-23 17:40 ` [PATCH v2 7/7] color: support strike-through attribute Jeff King
2016-06-23 18:36 ` Junio C Hamano
2016-06-23 18:39 ` Jeff King
2016-06-23 18:52 ` Junio C Hamano
2016-06-23 19:03 ` Junio C Hamano
2016-06-23 19:04 ` Jeff King
2016-06-23 19:11 ` Junio C Hamano
2016-06-23 19:56 ` Junio C Hamano
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=20160623173229.GB15774@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=scourtois@cubyx.fr \
/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).