From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on dcvr.yhbt.net X-Spam-Level: X-Spam-ASN: AS31976 209.132.180.0/23 X-Spam-Status: No, score=-3.7 required=3.0 tests=AWL,BAYES_00,DKIM_SIGNED, DKIM_VALID,HEADER_FROM_DIFFERENT_DOMAINS,MAILING_LIST_MULTI,RCVD_IN_DNSWL_HI, T_DKIMWL_WL_MED shortcircuit=no autolearn=ham autolearn_force=no version=3.4.0 Received: from vger.kernel.org (vger.kernel.org [209.132.180.67]) by dcvr.yhbt.net (Postfix) with ESMTP id 07A671F424 for ; Thu, 26 Apr 2018 04:25:34 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1751465AbeDZEZb (ORCPT ); Thu, 26 Apr 2018 00:25:31 -0400 Received: from mail-pg0-f49.google.com ([74.125.83.49]:36132 "EHLO mail-pg0-f49.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1751309AbeDZEZ2 (ORCPT ); Thu, 26 Apr 2018 00:25:28 -0400 Received: by mail-pg0-f49.google.com with SMTP id i6so14926567pgv.3 for ; Wed, 25 Apr 2018 21:25:27 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ttaylorr-com.20150623.gappssmtp.com; s=20150623; h=date:from:to:cc:subject:message-id:references:mime-version :content-disposition:in-reply-to:user-agent; bh=WxtsBCklBxckXTfNoh55eF4tb3ygGSDFKMWtCaPw5k0=; b=wdICBURTFf+gOlITy1Pr5e75vHEqDP6ntaTtoujF5XDyj845wfaOvFCfgsp0ixQLYD cYxt1VZiRAxbb2AIguTPAHaiu65K++Hnz4kPhyqPFtIapsuNrX/9Z4Q6J2LnSEHViGmY cJcpbeQE0xKx572ms9THZZm4bbGw7GgVdx5VmvuVDwkziJ0vvD9N3pBnmd0c9ekkSXs0 3gb4fTppmKw0WKttRjLqQZaxuZhVsyHZgMUQDuhjMKLQK8Fkp3lseIYjQu75wsPo5MBH TslcgyX5UBMclhk79QqeykRzpzpG+3fZvivvQfYcxuft2azv8aobTR8/TLVEKYbEGWI1 MoDA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:date:from:to:cc:subject:message-id:references :mime-version:content-disposition:in-reply-to:user-agent; bh=WxtsBCklBxckXTfNoh55eF4tb3ygGSDFKMWtCaPw5k0=; b=ZwD0sd3W/0EUhfivqACcg9KoF39Ryityx6Er1btgCnTpl2+GsdknWRVCkCjGFWuJ8v XMn8A9O7x6UVP/RUy1BphDon3gyaRlBlFFROEEQB3I2A9fDGIVbys/ySjUpiiCoYz6D/ pUDL/fEv1VIkbjlBkjvMhsdXWMjx2GEcARc9bJVdFmMwGtO1tVMzis363KlcPDLP0Od1 ADq3FXmXViZIylOuIcfomPYAQEWw/6lHoG/80Rh6U9zRzvUf+8v9n5lckoVmuO7vetHL l8m3a5szkQfiLF1YJ/HinalSpVGDoQrX7DRuqMv8klgBpY6UmrdPvSuZYqy+c+CdvNy9 6ygg== X-Gm-Message-State: ALQs6tAcF6eTunWUQGOiAUwXzKX8Ib7o3oxXtZXylfckpsZbv8HNNtm3 nqDIevVPF0GeGrJceOtr0Oq01xzx7qs= X-Google-Smtp-Source: AIpwx48PUGsmwAMxMGqVUAgNj9fGK+nziJHxsOpTcBdQ5u9p5RJaEqTtiHXXsjexSmYEMXF+HsDPIw== X-Received: by 10.99.106.4 with SMTP id f4mr25348458pgc.225.1524716726785; Wed, 25 Apr 2018 21:25:26 -0700 (PDT) Received: from localhost ([2601:602:9500:1120:b5ff:86d4:d359:c7bd]) by smtp.gmail.com with ESMTPSA id y7sm42922107pfi.185.2018.04.25.21.25.25 (version=TLS1_2 cipher=ECDHE-RSA-AES128-GCM-SHA256 bits=128/128); Wed, 25 Apr 2018 21:25:25 -0700 (PDT) Date: Wed, 25 Apr 2018 21:25:25 -0700 From: Taylor Blau To: git@vger.kernel.org Cc: gitster@pobox.com Subject: [PATCH 3/5] builtin/config: introduce `--default` Message-ID: <273278d4a8d741c27b31c583faed3b345ccbc2d4.1524716420.git.me@ttaylorr.com> References: MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: User-Agent: Mutt/1.9.5 (2018-04-13) Sender: git-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org For some use cases, callers of the `git-config(1)` builtin would like to fallback to default values when the variable asked for does not exist. In addition, users would like to use existing type specifiers to ensure that values are parsed correctly when they do exist in the configuration. For example, to fetch a value without a type specifier and fallback to `$fallback`, the following is required: $ git config core.foo || echo "$fallback" This is fine for most values, but can be tricky for difficult-to-express `$fallback`'s, like ANSI color codes. This motivates `--get-color`, which is a one-off exception to the normal type specifier rules wherein a user specifies both the configuration variable and an optional fallback. Both are formatted according to their type specifier, which eases the burden on the user to ensure that values are correctly formatted. This commit (and those following it in this series) aim to eventually replace `--get-color` with a consistent alternative. By introducing `--default`, we allow the `--get-color` action to be promoted to a `--type=color` type specifier, retaining the "fallback" behavior via the `--default` flag introduced in this commit. For example, we aim to replace: $ git config --get-color variable [default] [...] with: $ git config --default default --type=color variable [...] Values filled by `--default` behave exactly as if they were present in the affected configuration file; they will be parsed by type specifiers without the knowledge that they are not themselves present in the configuration. Specifically, this means that the following will work: $ git config --int --default 1M does.not.exist 1048576 In subsequent commits, we will offer `--type=color`, which (in conjunction with `--default`) will be sufficient to replace `--get-color`. Signed-off-by: Taylor Blau --- Documentation/git-config.txt | 4 ++++ builtin/config.c | 18 ++++++++++++++++++ t/t1310-config-default.sh | 36 ++++++++++++++++++++++++++++++++++++ 3 files changed, 58 insertions(+) create mode 100755 t/t1310-config-default.sh diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt index b759009c75..c3adafd78a 100644 --- a/Documentation/git-config.txt +++ b/Documentation/git-config.txt @@ -240,6 +240,10 @@ Valid ``'s include: using `--file`, `--global`, etc) and `on` when searching all config files. +--default :: + When using `--get`, and the requested variable is not found, behave as if + were the value assigned to the that variable. + CONFIGURATION ------------- `pager.config` is only respected when listing configuration, i.e., when diff --git a/builtin/config.c b/builtin/config.c index 2f91ef15a4..d7acf912cd 100644 --- a/builtin/config.c +++ b/builtin/config.c @@ -26,6 +26,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, type; +static char *default_value; static int end_null; static int respect_includes_opt = -1; static struct config_options config_options; @@ -150,6 +151,7 @@ static struct option builtin_config_options[] = { OPT_BOOL(0, "name-only", &omit_values, N_("show variable names only")), OPT_BOOL(0, "includes", &respect_includes_opt, N_("respect include directives on lookup")), OPT_BOOL(0, "show-origin", &show_origin, N_("show origin of config (file, standard input, blob, command line)")), + OPT_STRING(0, "default", &default_value, N_("value"), N_("with --get, use default value when missing entry")), OPT_END(), }; @@ -314,6 +316,16 @@ static int get_value(const char *key_, const char *regex_) config_with_options(collect_config, &values, &given_config_source, &config_options); + if (!values.nr && default_value) { + struct strbuf *item; + ALLOC_GROW(values.items, values.nr + 1, values.alloc); + item = &values.items[values.nr++]; + strbuf_init(item, 0); + if (format_config(item, key_, default_value) < 0) + die(_("failed to format default config value: %s"), + default_value); + } + ret = !values.nr; for (i = 0; i < values.nr; i++) { @@ -652,6 +664,12 @@ int cmd_config(int argc, const char **argv, const char *prefix) usage_with_options(builtin_config_usage, builtin_config_options); } + if (default_value && !(actions & ACTION_GET)) { + error("--default is only applicable to --get"); + usage_with_options(builtin_config_usage, + builtin_config_options); + } + if (actions & PAGING_ACTIONS) setup_auto_pager("config", 1); diff --git a/t/t1310-config-default.sh b/t/t1310-config-default.sh new file mode 100755 index 0000000000..6049d91708 --- /dev/null +++ b/t/t1310-config-default.sh @@ -0,0 +1,36 @@ +#!/bin/sh + +test_description='Test git config in different settings (with --default)' + +. ./test-lib.sh + +test_expect_success 'uses --default when entry missing' ' + echo quux >expect && + git config -f config --default=quux core.foo >actual && + test_cmp expect actual +' + +test_expect_success 'does not use --default when entry present' ' + echo bar >expect && + git -c core.foo=bar config --default=baz core.foo >actual && + test_cmp expect actual +' + +test_expect_success 'canonicalizes --default with appropriate type' ' + echo true >expect && + git config -f config --default=yes --bool core.foo >actual && + test_cmp expect actual +' + +test_expect_success 'dies when --default cannot be parsed' ' + test_must_fail git config -f config --type=expiry-date --default=x --get \ + not.a.section 2>error && + test_i18ngrep "failed to format default config value" error +' + +test_expect_success 'does not allow --default without --get' ' + test_must_fail git config --default=quux --unset a.section >output 2>&1 && + test_i18ngrep "\-\-default is only applicable to" output +' + +test_done -- 2.17.0