document behavior of empty color name

Commit 55cccf4bb (color_parse_mem: allow empty color spec,
2017-02-01) clearly defined the behavior of an empty color
config variable. Let's document that, and give a hint about
why it might be useful.

It's important not to say that it makes the item uncolored,
because it doesn't. It just sets no attributes, which means
that any previous attributes continue to take effect.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Jeff King 2017-02-02 13:42:44 +01:00 коммит произвёл Junio C Hamano
Родитель 55cccf4bb3
Коммит 512aba261a
1 изменённых файлов: 3 добавлений и 0 удалений

Просмотреть файл

@ -170,6 +170,9 @@ The position of any attributes with respect to the colors
be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`, be turned off by prefixing them with `no` or `no-` (e.g., `noreverse`,
`no-ul`, etc). `no-ul`, etc).
+ +
An empty color string produces no color effect at all. This can be used
to avoid coloring specific elements without disabling color entirely.
+
For git's pre-defined color slots, the attributes are meant to be reset 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 at the beginning of each item in the colored output. So setting
`color.decorate.branch` to `black` will paint that branch name in a `color.decorate.branch` to `black` will paint that branch name in a