From: Taylor Blau <me@ttaylorr.com>
To: me@ttaylorr.com
Cc: git@vger.kernel.org, gitster@pobox.com, peff@peff.net,
sunshine@sunshineco.com
Subject: [PATCH v2 4/4] builtin/config: introduce `--color` type specifier
Date: Fri, 23 Mar 2018 20:55:56 -0400 [thread overview]
Message-ID: <20180324005556.8145-5-me@ttaylorr.com> (raw)
In-Reply-To: <20180324005556.8145-1-me@ttaylorr.com>
As of this commit, the canonical way to retreive an ANSI-compatible
color escape sequence from a configuration file is with the
`--get-color` action.
This is to allow Git to "fall back" on a default value for the color
should the given section not exist in the specified configuration(s).
With the addition of `--default`, this is no longer needed since:
$ git config --default red --color core.section
will be have exactly as:
$ git config --get-color core.section red
For consistency, let's introduce `--color` and encourage `--color`,
`--default` together over `--get-color` alone.
Signed-off-by: Taylor Blau <me@ttaylorr.com>
---
Documentation/git-config.txt | 7 +++++++
builtin/config.c | 13 +++++++++++++
t/t1300-repo-config.sh | 24 ++++++++++++++++++++++++
t/t1310-config-default.sh | 6 ++++++
4 files changed, 50 insertions(+)
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index d9d45aca3..e70c0a855 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -56,6 +56,9 @@ conversion to canonical form. Currently supported type specifiers are:
`expiry-date`::
The value is taken as a timestamp.
+`color`::
+ The value is taken as an ANSI color escape sequence.
+
For more information about the above type specifiers, see <<OPTIONS>> below.
When reading, the values are read from the system, global and
@@ -198,6 +201,10 @@ See also <<FILES>>.
a fixed or relative date-string to a timestamp. This option
has no effect when setting the value.
+--color::
+ `git config` will ensure that the output is converted to an
+ ANSI color escape sequence.
+
-z::
--null::
For all options that output values and/or keys, always
diff --git a/builtin/config.c b/builtin/config.c
index 1410be850..e8661bc12 100644
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -61,6 +61,7 @@ static int show_origin;
#define TYPE_BOOL_OR_INT (1<<2)
#define TYPE_PATH (1<<3)
#define TYPE_EXPIRY_DATE (1<<4)
+#define TYPE_COLOR (1<<5)
static struct option builtin_config_options[] = {
OPT_GROUP(N_("Config file location")),
@@ -90,6 +91,7 @@ static struct option builtin_config_options[] = {
OPT_BIT(0, "bool-or-int", &types, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
OPT_BIT(0, "path", &types, N_("value is a path (file or directory name)"), TYPE_PATH),
OPT_BIT(0, "expiry-date", &types, N_("value is an expiry date"), TYPE_EXPIRY_DATE),
+ OPT_BIT(0, "color", &types, N_("value is a color"), TYPE_COLOR),
OPT_GROUP(N_("Other")),
OPT_BOOL('z', "null", &end_null, N_("terminate values with NUL byte")),
OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")),
@@ -175,6 +177,11 @@ static int format_config(struct strbuf *buf, const char *key_, const char *value
if (git_config_expiry_date(&t, key_, value_) < 0)
return -1;
strbuf_addf(buf, "%"PRItime, t);
+ } else if (types == TYPE_COLOR) {
+ char v[COLOR_MAXLEN];
+ if (git_config_color(v, key_, value_) < 0)
+ return -1;
+ strbuf_addstr(buf, v);
} else if (value_) {
strbuf_addstr(buf, value_);
} else {
@@ -320,6 +327,12 @@ static char *normalize_value(const char *key, const char *value)
else
return xstrdup(v ? "true" : "false");
}
+ if (types == TYPE_COLOR) {
+ char v[COLOR_MAXLEN];
+ if (!git_config_color(v, key, value))
+ return xstrdup(value);
+ die("cannot parse color '%s'", value);
+ }
die("BUG: cannot normalize type %d", types);
}
diff --git a/t/t1300-repo-config.sh b/t/t1300-repo-config.sh
index 4f8e6f5fd..dab94d0c4 100755
--- a/t/t1300-repo-config.sh
+++ b/t/t1300-repo-config.sh
@@ -931,6 +931,30 @@ test_expect_success 'get --expiry-date' '
test_must_fail git config --expiry-date date.invalid1
'
+test_expect_success 'get --color' '
+ rm .git/config &&
+ git config foo.color "red" &&
+ git config --get --color foo.color | test_decode_color >actual &&
+ echo "<RED>" >expect &&
+ test_cmp expect actual
+'
+
+cat >expect << EOF
+[foo]
+ color = red
+EOF
+
+test_expect_success 'set --color' '
+ rm .git/config &&
+ git config --color foo.color "red" &&
+ test_cmp expect .git/config
+'
+
+test_expect_success 'get --color barfs on non-color' '
+ echo "[foo]bar=not-a-color" >.git/config &&
+ test_must_fail git config --get --color foo.bar
+'
+
cat > expect << EOF
[quote]
leading = " test"
diff --git a/t/t1310-config-default.sh b/t/t1310-config-default.sh
index 0e464c206..0ebece7d2 100755
--- a/t/t1310-config-default.sh
+++ b/t/t1310-config-default.sh
@@ -62,6 +62,12 @@ test_expect_success 'marshal default value as expiry-date' '
test_cmp expect actual
'
+test_expect_success 'marshal default value as color' '
+ echo "\033[31m" >expect &&
+ git config --default red --color core.foo >actual &&
+ test_cmp expect actual
+'
+
test_expect_success 'does not allow --default with --get-all' '
test_must_fail git config --default quux --get-all a >output 2>&1 &&
test_i18ngrep "\-\-default is only applicable to" output
--
2.16.2.440.gc6284da4f
next prev parent reply other threads:[~2018-03-24 0:56 UTC|newest]
Thread overview: 83+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-03-06 2:17 [PATCH 0/4] Teach `--default` to `git-config(1)` Taylor Blau
2018-03-06 2:17 ` [PATCH 1/4] builtin/config: introduce `--default` Taylor Blau
2018-03-06 6:52 ` Jeff King
2018-03-06 7:14 ` Eric Sunshine
2018-03-06 7:08 ` Eric Sunshine
2018-03-06 2:17 ` [PATCH 2/4] Documentation: list all type specifiers in config prose Taylor Blau
2018-03-06 6:52 ` Jeff King
2018-03-06 7:40 ` Junio C Hamano
2018-03-06 2:17 ` [PATCH 3/4] config.c: introduce 'git_config_color' to parse ANSI colors Taylor Blau
2018-03-06 6:53 ` Jeff King
2018-03-06 2:17 ` [PATCH 4/4] builtin/config: introduce `--color` type specifier Taylor Blau
2018-03-06 7:00 ` Jeff King
2018-03-06 2:20 ` [PATCH 0/4] Teach `--default` to `git-config(1)` Taylor Blau
2018-03-24 0:55 ` [PATCH v2 " Taylor Blau
2018-03-24 0:55 ` [PATCH v2 1/4] builtin/config: introduce `--default` Taylor Blau
2018-03-26 8:34 ` Jeff King
2018-03-29 1:31 ` Taylor Blau
2018-03-24 0:55 ` [PATCH v2 2/4] Documentation: list all type specifiers in config prose Taylor Blau
2018-03-26 8:55 ` Jeff King
2018-03-29 1:32 ` Taylor Blau
2018-03-24 0:55 ` [PATCH v2 3/4] config.c: introduce 'git_config_color' to parse ANSI colors Taylor Blau
2018-03-24 0:55 ` Taylor Blau [this message]
2018-03-26 9:16 ` [PATCH v2 4/4] builtin/config: introduce `--color` type specifier Jeff King
2018-03-29 1:36 ` Taylor Blau
2018-03-26 9:18 ` [PATCH v2 0/4] Teach `--default` to `git-config(1)` Jeff King
2018-03-29 1:16 ` [PATCH v3 " Taylor Blau
2018-03-29 1:16 ` [PATCH v3 1/3] builtin/config: introduce `--default` Taylor Blau
2018-03-30 18:06 ` Junio C Hamano
2018-04-05 2:45 ` Taylor Blau
2018-03-30 20:23 ` Eric Sunshine
2018-04-05 2:46 ` Taylor Blau
2018-03-29 1:16 ` [PATCH v3 2/3] config.c: introduce 'git_config_color' to parse ANSI colors Taylor Blau
2018-03-30 20:26 ` Eric Sunshine
2018-04-05 2:47 ` Taylor Blau
2018-03-29 1:16 ` [PATCH v3 3/3] builtin/config: introduce `color` type specifier Taylor Blau
2018-03-30 18:09 ` Junio C Hamano
2018-04-05 2:48 ` Taylor Blau
2018-03-29 1:29 ` [PATCH v3 0/4] Teach `--default` to `git-config(1)` Taylor Blau
2018-04-05 2:58 ` [PATCH v4 0/3] " Taylor Blau
2018-04-05 22:37 ` Jeff King
[not found] ` <cover.1522896713.git.me@ttaylorr.com>
2018-04-05 2:59 ` [PATCH v4 1/3] builtin/config: introduce `--default` Taylor Blau
2018-04-05 22:29 ` Jeff King
2018-04-06 5:40 ` Taylor Blau
2018-04-08 23:18 ` Junio C Hamano
2018-04-10 0:20 ` Taylor Blau
2018-04-05 22:40 ` Eric Sunshine
2018-04-06 5:50 ` Taylor Blau
2018-04-05 2:59 ` [PATCH v4 2/3] config.c: introduce 'git_config_color' to parse ANSI colors Taylor Blau
2018-04-05 2:59 ` [PATCH v4 3/3] builtin/config: introduce `color` type specifier Taylor Blau
2018-04-05 22:36 ` Jeff King
2018-04-05 22:52 ` Eric Sunshine
2018-04-05 22:53 ` Jeff King
2018-04-06 6:05 ` Taylor Blau
2018-04-06 6:02 ` Taylor Blau
2018-04-06 5:27 ` [PATCH v5 0/2] *** SUBJECT HERE *** Taylor Blau
2018-04-06 5:40 ` Jacob Keller
2018-04-06 5:29 ` [PATCH v5 0/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-04-06 5:32 ` Taylor Blau
[not found] ` <cover.1522992443.git.me@ttaylorr.com>
2018-04-06 5:29 ` [PATCH v5 1/2] builtin/config.c: treat type specifiers singularly Taylor Blau
2018-04-06 5:29 ` [PATCH v5 2/2] builtin/config.c: prefer `--type=bool` over `--bool`, etc Taylor Blau
2018-04-06 6:14 ` Eric Sunshine
2018-04-06 6:41 ` Taylor Blau
2018-04-06 14:55 ` Jeff King
2018-04-07 1:00 ` Taylor Blau
2018-04-06 6:30 ` [PATCH v5 0/3] builtin/config: introduce `--default` Taylor Blau
[not found] ` <cover.1522996150.git.me@ttaylorr.com>
2018-04-06 6:30 ` [PATCH v5 1/3] " Taylor Blau
2018-04-06 6:53 ` Eric Sunshine
2018-04-06 7:40 ` Eric Sunshine
2018-04-07 0:58 ` Taylor Blau
2018-04-07 8:44 ` Eric Sunshine
2018-04-07 0:49 ` Taylor Blau
2018-04-07 8:38 ` Eric Sunshine
2018-04-06 6:30 ` [PATCH v5 2/3] config.c: introduce 'git_config_color' to parse ANSI colors Taylor Blau
2018-04-06 6:30 ` [PATCH v5 3/3] builtin/config: introduce `color` type specifier Taylor Blau
2018-04-06 7:29 ` Eric Sunshine
2018-04-07 0:42 ` Taylor Blau
2018-04-10 0:18 ` [PATCH v6 0/3] Teach `--default` to `git-config(1)` Taylor Blau
[not found] ` <cover.1523319159.git.me@ttaylorr.com>
2018-04-10 0:18 ` [PATCH v6 1/3] builtin/config: introduce `--default` Taylor Blau
2018-04-10 1:50 ` Junio C Hamano
2018-04-10 0:18 ` [PATCH v6 2/3] config.c: introduce 'git_config_color' to parse ANSI colors Taylor Blau
2018-04-10 0:18 ` [PATCH v6 3/3] builtin/config: introduce `color` type specifier Taylor Blau
2018-04-10 0:18 ` Taylor Blau
2018-04-10 1:54 ` 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=20180324005556.8145-5-me@ttaylorr.com \
--to=me@ttaylorr.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=peff@peff.net \
--cc=sunshine@sunshineco.com \
/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).