Merge branch 'tb/config-type'
The "git config" command uses separate options e.g. "--int", "--bool", etc. to specify what type the caller wants the value to be interpreted as. A new "--type=<typename>" option has been introduced, which would make it cleaner to define new types. * tb/config-type: builtin/config.c: support `--type=<type>` as preferred alias for `--<type>` builtin/config.c: treat type specifiers singularlymaint
Junio C Hamano
commit
e3e042b185
|
|
@ -9,13 +9,13 @@ git-config - Get and set repository or global options
|
|||
SYNOPSIS
|
||||
--------
|
||||
[verse]
|
||||
'git config' [<file-option>] [type] [--show-origin] [-z|--null] name [value [value_regex]]
|
||||
'git config' [<file-option>] [type] --add name value
|
||||
'git config' [<file-option>] [type] --replace-all name value [value_regex]
|
||||
'git config' [<file-option>] [type] [--show-origin] [-z|--null] --get name [value_regex]
|
||||
'git config' [<file-option>] [type] [--show-origin] [-z|--null] --get-all name [value_regex]
|
||||
'git config' [<file-option>] [type] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex]
|
||||
'git config' [<file-option>] [type] [-z|--null] --get-urlmatch name URL
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] name [value [value_regex]]
|
||||
'git config' [<file-option>] [--type=<type>] --add name value
|
||||
'git config' [<file-option>] [--type=<type>] --replace-all name value [value_regex]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] --get name [value_regex]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] --get-all name [value_regex]
|
||||
'git config' [<file-option>] [--type=<type>] [--show-origin] [-z|--null] [--name-only] --get-regexp name_regex [value_regex]
|
||||
'git config' [<file-option>] [--type=<type>] [-z|--null] --get-urlmatch name URL
|
||||
'git config' [<file-option>] --unset name [value_regex]
|
||||
'git config' [<file-option>] --unset-all name [value_regex]
|
||||
'git config' [<file-option>] --rename-section old_name new_name
|
||||
|
|
@ -38,12 +38,10 @@ existing values that match the regexp are updated or unset. If
|
|||
you want to handle the lines that do *not* match the regex, just
|
||||
prepend a single exclamation mark in front (see also <<EXAMPLES>>).
|
||||
|
||||
The type specifier can be either `--int` or `--bool`, to make
|
||||
'git config' ensure that the variable(s) are of the given type and
|
||||
convert the value to the canonical form (simple decimal number for int,
|
||||
a "true" or "false" string for bool), or `--path`, which does some
|
||||
path expansion (see `--path` below). If no type specifier is passed, no
|
||||
checks or transformations are performed on the value.
|
||||
The `--type=<type>` option instructs 'git config' to ensure that incoming and
|
||||
outgoing values are canonicalize-able under the given <type>. If no
|
||||
`--type=<type>` is given, no canonicalization will be performed. Callers may
|
||||
unset an existing `--type` specifier with `--no-type`.
|
||||
|
||||
When reading, the values are read from the system, global and
|
||||
repository local configuration files by default, and options
|
||||
|
|
@ -160,30 +158,39 @@ See also <<FILES>>.
|
|||
--list::
|
||||
List all variables set in config file, along with their values.
|
||||
|
||||
--type <type>::
|
||||
'git config' will ensure that any input or output is valid under the given
|
||||
type constraint(s), and will canonicalize outgoing values in `<type>`'s
|
||||
canonical form.
|
||||
+
|
||||
Valid `<type>`'s include:
|
||||
+
|
||||
- 'bool': canonicalize values as either "true" or "false".
|
||||
- 'int': canonicalize values as simple decimal numbers. An optional suffix of
|
||||
'k', 'm', or 'g' will cause the value to be multiplied by 1024, 1048576, or
|
||||
1073741824 upon input.
|
||||
- 'bool-or-int': canonicalize according to either 'bool' or 'int', as described
|
||||
above.
|
||||
- 'path': canonicalize by adding a leading `~` to the value of `$HOME` and
|
||||
`~user` to the home directory for the specified user. This specifier has no
|
||||
effect when setting the value (but you can use `git config section.variable
|
||||
~/` from the command line to let your shell do the expansion.)
|
||||
- 'expiry-date': canonicalize by converting from a fixed or relative date-string
|
||||
to a timestamp. This specifier has no effect when setting the value.
|
||||
+
|
||||
|
||||
--bool::
|
||||
'git config' will ensure that the output is "true" or "false"
|
||||
|
||||
--int::
|
||||
'git config' will ensure that the output is a simple
|
||||
decimal number. An optional value suffix of 'k', 'm', or 'g'
|
||||
in the config file will cause the value to be multiplied
|
||||
by 1024, 1048576, or 1073741824 prior to output.
|
||||
|
||||
--bool-or-int::
|
||||
'git config' will ensure that the output matches the format of
|
||||
either --bool or --int, as described above.
|
||||
|
||||
--path::
|
||||
`git config` will expand a leading `~` to the value of
|
||||
`$HOME`, and `~user` to the home directory for the
|
||||
specified user. This option has no effect when setting the
|
||||
value (but you can use `git config section.variable ~/`
|
||||
from the command line to let your shell do the expansion).
|
||||
|
||||
--expiry-date::
|
||||
`git config` will ensure that the output is converted from
|
||||
a fixed or relative date-string to a timestamp. This option
|
||||
has no effect when setting the value.
|
||||
Historical options for selecting a type specifier. Prefer instead `--type`,
|
||||
(see: above).
|
||||
|
||||
--no-type::
|
||||
Un-sets the previously set type specifier (if one was previously set). This
|
||||
option requests that 'git config' not canonicalize the retrieved variable.
|
||||
`--no-type` has no effect without `--type=<type>` or `--<type>`.
|
||||
|
||||
-z::
|
||||
--null::
|
||||
|
|
|
|||
104
builtin/config.c
104
builtin/config.c
|
|
@ -25,7 +25,7 @@ static char term = '\n';
|
|||
|
||||
static int use_global_config, use_system_config, use_local_config;
|
||||
static struct git_config_source given_config_source;
|
||||
static int actions, types;
|
||||
static int actions, type;
|
||||
static int end_null;
|
||||
static int respect_includes_opt = -1;
|
||||
static struct config_options config_options;
|
||||
|
|
@ -55,11 +55,65 @@ static int show_origin;
|
|||
#define PAGING_ACTIONS (ACTION_LIST | ACTION_GET_ALL | \
|
||||
ACTION_GET_REGEXP | ACTION_GET_URLMATCH)
|
||||
|
||||
#define TYPE_BOOL (1<<0)
|
||||
#define TYPE_INT (1<<1)
|
||||
#define TYPE_BOOL_OR_INT (1<<2)
|
||||
#define TYPE_PATH (1<<3)
|
||||
#define TYPE_EXPIRY_DATE (1<<4)
|
||||
#define TYPE_BOOL 1
|
||||
#define TYPE_INT 2
|
||||
#define TYPE_BOOL_OR_INT 3
|
||||
#define TYPE_PATH 4
|
||||
#define TYPE_EXPIRY_DATE 5
|
||||
|
||||
#define OPT_CALLBACK_VALUE(s, l, v, h, i) \
|
||||
{ OPTION_CALLBACK, (s), (l), (v), NULL, (h), PARSE_OPT_NOARG | \
|
||||
PARSE_OPT_NONEG, option_parse_type, (i) }
|
||||
|
||||
static struct option builtin_config_options[];
|
||||
|
||||
static int option_parse_type(const struct option *opt, const char *arg,
|
||||
int unset)
|
||||
{
|
||||
int new_type, *to_type;
|
||||
|
||||
if (unset) {
|
||||
*((int *) opt->value) = 0;
|
||||
return 0;
|
||||
}
|
||||
|
||||
/*
|
||||
* To support '--<type>' style flags, begin with new_type equal to
|
||||
* opt->defval.
|
||||
*/
|
||||
new_type = opt->defval;
|
||||
if (!new_type) {
|
||||
if (!strcmp(arg, "bool"))
|
||||
new_type = TYPE_BOOL;
|
||||
else if (!strcmp(arg, "int"))
|
||||
new_type = TYPE_INT;
|
||||
else if (!strcmp(arg, "bool-or-int"))
|
||||
new_type = TYPE_BOOL_OR_INT;
|
||||
else if (!strcmp(arg, "path"))
|
||||
new_type = TYPE_PATH;
|
||||
else if (!strcmp(arg, "expiry-date"))
|
||||
new_type = TYPE_EXPIRY_DATE;
|
||||
else
|
||||
die(_("unrecognized --type argument, %s"), arg);
|
||||
}
|
||||
|
||||
to_type = opt->value;
|
||||
if (*to_type && *to_type != new_type) {
|
||||
/*
|
||||
* Complain when there is a new type not equal to the old type.
|
||||
* This allows for combinations like '--int --type=int' and
|
||||
* '--type=int --type=int', but disallows ones like '--type=bool
|
||||
* --int' and '--type=bool
|
||||
* --type=int'.
|
||||
*/
|
||||
error("only one type at a time.");
|
||||
usage_with_options(builtin_config_usage,
|
||||
builtin_config_options);
|
||||
}
|
||||
*to_type = new_type;
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static struct option builtin_config_options[] = {
|
||||
OPT_GROUP(N_("Config file location")),
|
||||
|
|
@ -84,11 +138,12 @@ static struct option builtin_config_options[] = {
|
|||
OPT_BIT(0, "get-color", &actions, N_("find the color configured: slot [default]"), ACTION_GET_COLOR),
|
||||
OPT_BIT(0, "get-colorbool", &actions, N_("find the color setting: slot [stdout-is-tty]"), ACTION_GET_COLORBOOL),
|
||||
OPT_GROUP(N_("Type")),
|
||||
OPT_BIT(0, "bool", &types, N_("value is \"true\" or \"false\""), TYPE_BOOL),
|
||||
OPT_BIT(0, "int", &types, N_("value is decimal number"), TYPE_INT),
|
||||
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_CALLBACK('t', "type", &type, "", N_("value is given this type"), option_parse_type),
|
||||
OPT_CALLBACK_VALUE(0, "bool", &type, N_("value is \"true\" or \"false\""), TYPE_BOOL),
|
||||
OPT_CALLBACK_VALUE(0, "int", &type, N_("value is decimal number"), TYPE_INT),
|
||||
OPT_CALLBACK_VALUE(0, "bool-or-int", &type, N_("value is --bool or --int"), TYPE_BOOL_OR_INT),
|
||||
OPT_CALLBACK_VALUE(0, "path", &type, N_("value is a path (file or directory name)"), TYPE_PATH),
|
||||
OPT_CALLBACK_VALUE(0, "expiry-date", &type, N_("value is an expiry date"), TYPE_EXPIRY_DATE),
|
||||
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")),
|
||||
|
|
@ -149,26 +204,26 @@ static int format_config(struct strbuf *buf, const char *key_, const char *value
|
|||
if (show_keys)
|
||||
strbuf_addch(buf, key_delim);
|
||||
|
||||
if (types == TYPE_INT)
|
||||
if (type == TYPE_INT)
|
||||
strbuf_addf(buf, "%"PRId64,
|
||||
git_config_int64(key_, value_ ? value_ : ""));
|
||||
else if (types == TYPE_BOOL)
|
||||
else if (type == TYPE_BOOL)
|
||||
strbuf_addstr(buf, git_config_bool(key_, value_) ?
|
||||
"true" : "false");
|
||||
else if (types == TYPE_BOOL_OR_INT) {
|
||||
else if (type == TYPE_BOOL_OR_INT) {
|
||||
int is_bool, v;
|
||||
v = git_config_bool_or_int(key_, value_, &is_bool);
|
||||
if (is_bool)
|
||||
strbuf_addstr(buf, v ? "true" : "false");
|
||||
else
|
||||
strbuf_addf(buf, "%d", v);
|
||||
} else if (types == TYPE_PATH) {
|
||||
} else if (type == TYPE_PATH) {
|
||||
const char *v;
|
||||
if (git_config_pathname(&v, key_, value_) < 0)
|
||||
return -1;
|
||||
strbuf_addstr(buf, v);
|
||||
free((char *)v);
|
||||
} else if (types == TYPE_EXPIRY_DATE) {
|
||||
} else if (type == TYPE_EXPIRY_DATE) {
|
||||
timestamp_t t;
|
||||
if (git_config_expiry_date(&t, key_, value_) < 0)
|
||||
return -1;
|
||||
|
|
@ -287,7 +342,7 @@ static char *normalize_value(const char *key, const char *value)
|
|||
if (!value)
|
||||
return NULL;
|
||||
|
||||
if (types == 0 || types == TYPE_PATH || types == TYPE_EXPIRY_DATE)
|
||||
if (type == 0 || type == TYPE_PATH || type == TYPE_EXPIRY_DATE)
|
||||
/*
|
||||
* We don't do normalization for TYPE_PATH here: If
|
||||
* the path is like ~/foobar/, we prefer to store
|
||||
|
|
@ -296,11 +351,11 @@ static char *normalize_value(const char *key, const char *value)
|
|||
* Also don't do normalization for expiry dates.
|
||||
*/
|
||||
return xstrdup(value);
|
||||
if (types == TYPE_INT)
|
||||
if (type == TYPE_INT)
|
||||
return xstrfmt("%"PRId64, git_config_int64(key, value));
|
||||
if (types == TYPE_BOOL)
|
||||
if (type == TYPE_BOOL)
|
||||
return xstrdup(git_config_bool(key, value) ? "true" : "false");
|
||||
if (types == TYPE_BOOL_OR_INT) {
|
||||
if (type == TYPE_BOOL_OR_INT) {
|
||||
int is_bool, v;
|
||||
v = git_config_bool_or_int(key, value, &is_bool);
|
||||
if (!is_bool)
|
||||
|
|
@ -309,7 +364,7 @@ static char *normalize_value(const char *key, const char *value)
|
|||
return xstrdup(v ? "true" : "false");
|
||||
}
|
||||
|
||||
die("BUG: cannot normalize type %d", types);
|
||||
die("BUG: cannot normalize type %d", type);
|
||||
}
|
||||
|
||||
static int get_color_found;
|
||||
|
|
@ -566,12 +621,7 @@ int cmd_config(int argc, const char **argv, const char *prefix)
|
|||
key_delim = '\n';
|
||||
}
|
||||
|
||||
if (HAS_MULTI_BITS(types)) {
|
||||
error("only one type at a time.");
|
||||
usage_with_options(builtin_config_usage, builtin_config_options);
|
||||
}
|
||||
|
||||
if ((actions & (ACTION_GET_COLOR|ACTION_GET_COLORBOOL)) && types) {
|
||||
if ((actions & (ACTION_GET_COLOR|ACTION_GET_COLORBOOL)) && type) {
|
||||
error("--get-color and variable type are incoherent");
|
||||
usage_with_options(builtin_config_usage, builtin_config_options);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -742,7 +742,7 @@ test_expect_success bool '
|
|||
do
|
||||
git config --bool --get bool.true$i >>result
|
||||
git config --bool --get bool.false$i >>result
|
||||
done &&
|
||||
done &&
|
||||
test_cmp expect result'
|
||||
|
||||
test_expect_success 'invalid bool (--get)' '
|
||||
|
|
@ -1686,6 +1686,69 @@ test_expect_success '--local requires a repo' '
|
|||
test_expect_code 128 nongit git config --local foo.bar
|
||||
'
|
||||
|
||||
cat >.git/config <<-\EOF &&
|
||||
[core]
|
||||
foo = true
|
||||
number = 10
|
||||
big = 1M
|
||||
EOF
|
||||
|
||||
test_expect_success 'identical modern --type specifiers are allowed' '
|
||||
git config --type=int --type=int core.big >actual &&
|
||||
echo 1048576 >expect &&
|
||||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success 'identical legacy --type specifiers are allowed' '
|
||||
git config --int --int core.big >actual &&
|
||||
echo 1048576 >expect &&
|
||||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success 'identical mixed --type specifiers are allowed' '
|
||||
git config --int --type=int core.big >actual &&
|
||||
echo 1048576 >expect &&
|
||||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success 'non-identical modern --type specifiers are not allowed' '
|
||||
test_must_fail git config --type=int --type=bool core.big 2>error &&
|
||||
test_i18ngrep "only one type at a time" error
|
||||
'
|
||||
|
||||
test_expect_success 'non-identical legacy --type specifiers are not allowed' '
|
||||
test_must_fail git config --int --bool core.big 2>error &&
|
||||
test_i18ngrep "only one type at a time" error
|
||||
'
|
||||
|
||||
test_expect_success 'non-identical mixed --type specifiers are not allowed' '
|
||||
test_must_fail git config --type=int --bool core.big 2>error &&
|
||||
test_i18ngrep "only one type at a time" error
|
||||
'
|
||||
|
||||
test_expect_success '--type allows valid type specifiers' '
|
||||
echo "true" >expect &&
|
||||
git config --type=bool core.foo >actual &&
|
||||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success '--no-type unsets type specifiers' '
|
||||
echo "10" >expect &&
|
||||
git config --type=bool --no-type core.number >actual &&
|
||||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success 'unset type specifiers may be reset to conflicting ones' '
|
||||
echo 1048576 >expect &&
|
||||
git config --type=bool --no-type --type=int core.big >actual &&
|
||||
test_cmp expect actual
|
||||
'
|
||||
|
||||
test_expect_success '--type rejects unknown specifiers' '
|
||||
test_must_fail git config --type=nonsense core.foo 2>error &&
|
||||
test_i18ngrep "unrecognized --type argument" error
|
||||
'
|
||||
|
||||
test_expect_success '--replace-all does not invent newlines' '
|
||||
q_to_tab >.git/config <<-\EOF &&
|
||||
[abc]key
|
||||
|
|
|
|||
Loading…
Reference in New Issue