From: Ramsay Jones <ramsay@ramsayjones.plus.com>
To: larsxschneider@gmail.com, git@vger.kernel.org
Cc: peff@peff.net, sschuberth@gmail.com, sunshine@sunshineco.com,
hvoigt@hvoigt.net, sbeller@google.com,
Johannes.Schindelin@gmx.de, gitster@pobox.com
Subject: Re: [PATCH v4 2/3] config: add 'type' to config_source struct that identifies config type
Date: Mon, 15 Feb 2016 21:30:29 +0000 [thread overview]
Message-ID: <56C24375.4080007@ramsayjones.plus.com> (raw)
In-Reply-To: <1455531466-16617-3-git-send-email-larsxschneider@gmail.com>
On 15/02/16 10:17, larsxschneider@gmail.com wrote:
> From: Lars Schneider <larsxschneider@gmail.com>
>
> Use the config type to print more detailed error messages that inform
> the user about the origin of a config error (file, stdin, blob).
>
> Signed-off-by: Lars Schneider <larsxschneider@gmail.com>
> ---
> cache.h | 6 ++++--
> config.c | 36 +++++++++++++++++++++++++-----------
> submodule-config.c | 4 ++--
> t/t1300-repo-config.sh | 8 +++++++-
> t/t1308-config-set.sh | 4 ++--
> 5 files changed, 40 insertions(+), 18 deletions(-)
>
> diff --git a/cache.h b/cache.h
> index c63fcc1..8d86e5c 100644
> --- a/cache.h
> +++ b/cache.h
> @@ -1485,8 +1485,8 @@ struct git_config_source {
> typedef int (*config_fn_t)(const char *, const char *, void *);
> extern int git_default_config(const char *, const char *, void *);
> extern int git_config_from_file(config_fn_t fn, const char *, void *);
> -extern int git_config_from_buf(config_fn_t fn, const char *name,
> - const char *buf, size_t len, void *data);
> +extern int git_config_from_mem(config_fn_t fn, const char *type,
> + const char *name, const char *buf, size_t len, void *data);
> extern void git_config_push_parameter(const char *text);
> extern int git_config_from_parameters(config_fn_t fn, void *data);
> extern void git_config(config_fn_t fn, void *);
> @@ -1525,6 +1525,8 @@ extern const char *get_log_output_encoding(void);
> extern const char *get_commit_output_encoding(void);
>
> extern int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
> +extern const char *current_config_type();
> +extern const char *current_config_name();
>
> struct config_include_data {
> int depth;
> diff --git a/config.c b/config.c
> index 86a5eb2..5cf11b5 100644
> --- a/config.c
> +++ b/config.c
> @@ -24,6 +24,7 @@ struct config_source {
> size_t pos;
> } buf;
> } u;
> + const char *type;
> const char *name;
> const char *path;
> int die_on_error;
> @@ -471,9 +472,9 @@ static int git_parse_source(config_fn_t fn, void *data)
> break;
> }
> if (cf->die_on_error)
> - die(_("bad config file line %d in %s"), cf->linenr, cf->name);
> + die(_("bad config line %d in %s %s"), cf->linenr, cf->type, cf->name);
> else
> - return error(_("bad config file line %d in %s"), cf->linenr, cf->name);
> + return error(_("bad config line %d in %s %s"), cf->linenr, cf->type, cf->name);
> }
>
> static int parse_unit_factor(const char *end, uintmax_t *val)
> @@ -588,9 +589,9 @@ static void die_bad_number(const char *name, const char *value)
> if (!value)
> value = "";
>
> - if (cf && cf->name)
> - die(_("bad numeric config value '%s' for '%s' in %s: %s"),
> - value, name, cf->name, reason);
> + if (cf && cf->type && cf->name)
> + die(_("bad numeric config value '%s' for '%s' in %s %s: %s"),
> + value, name, cf->type, cf->name, reason);
> die(_("bad numeric config value '%s' for '%s': %s"), value, name, reason);
> }
>
> @@ -1061,11 +1062,13 @@ static int do_config_from(struct config_source *top, config_fn_t fn, void *data)
> }
>
> static int do_config_from_file(config_fn_t fn,
> - const char *name, const char *path, FILE *f, void *data)
> + const char *type, const char *name, const char *path, FILE *f,
> + void *data)
> {
> struct config_source top;
>
> top.u.file = f;
> + top.type = type;
> top.name = name;
> top.path = path;
> top.die_on_error = 1;
> @@ -1078,7 +1081,7 @@ static int do_config_from_file(config_fn_t fn,
>
> static int git_config_from_stdin(config_fn_t fn, void *data)
> {
> - return do_config_from_file(fn, "<stdin>", NULL, stdin, data);
> + return do_config_from_file(fn, "stdin", "", NULL, stdin, data);
I think this should be:
return do_config_from_file(fn, "file", "<stdin>", NULL, stdin, data);
ie. <stdin> is not a separate type, but a file that does not exist in
the filesystem and, thus, has no name. (what you use internally is a
separate issue, but <file,NULL> works for me.)
Also, I'm so used to '<stdin>' as the 'name' (token/handle) of that
file, that it looks very odd spelt otherwise. :-D
> }
>
> int git_config_from_file(config_fn_t fn, const char *filename, void *data)
> @@ -1089,21 +1092,22 @@ int git_config_from_file(config_fn_t fn, const char *filename, void *data)
> f = fopen(filename, "r");
> if (f) {
> flockfile(f);
> - ret = do_config_from_file(fn, filename, filename, f, data);
> + ret = do_config_from_file(fn, "file", filename, filename, f, data);
> funlockfile(f);
> fclose(f);
> }
> return ret;
> }
>
> -int git_config_from_buf(config_fn_t fn, const char *name, const char *buf,
> - size_t len, void *data)
> +int git_config_from_mem(config_fn_t fn, const char *type, const char *name,
> + const char *buf, size_t len, void *data)
> {
> struct config_source top;
>
> top.u.buf.buf = buf;
> top.u.buf.len = len;
> top.u.buf.pos = 0;
> + top.type = type;
> top.name = name;
> top.path = NULL;
> top.die_on_error = 0;
> @@ -1132,7 +1136,7 @@ static int git_config_from_blob_sha1(config_fn_t fn,
> return error("reference '%s' does not point to a blob", name);
> }
>
> - ret = git_config_from_buf(fn, name, buf, size, data);
> + ret = git_config_from_mem(fn, "blob", name, buf, size, data);
> free(buf);
>
> return ret;
> @@ -2385,3 +2389,13 @@ int parse_config_key(const char *var,
>
> return 0;
> }
> +
> +const char *current_config_type()
> +{
> + return cf && cf->type ? cf->type : "cmdline";
> +}
> +
> +const char *current_config_name()
> +{
> + return cf && cf->name ? cf->name : "";
> +}
> diff --git a/submodule-config.c b/submodule-config.c
> index fe8ceab..92502b5 100644
> --- a/submodule-config.c
> +++ b/submodule-config.c
> @@ -427,8 +427,8 @@ static const struct submodule *config_from(struct submodule_cache *cache,
> parameter.commit_sha1 = commit_sha1;
> parameter.gitmodules_sha1 = sha1;
> parameter.overwrite = 0;
> - git_config_from_buf(parse_config, rev.buf, config, config_size,
> - ¶meter);
> + git_config_from_mem(parse_config, "submodule-blob", rev.buf,
> + config, config_size, ¶meter);
> free(config);
>
> switch (lookup_type) {
> diff --git a/t/t1300-repo-config.sh b/t/t1300-repo-config.sh
> index 1782add..42ed5cc 100755
> --- a/t/t1300-repo-config.sh
> +++ b/t/t1300-repo-config.sh
> @@ -700,12 +700,18 @@ test_expect_success 'invalid unit' '
> git config aninvalid.unit >actual &&
> test_cmp expect actual &&
> cat >expect <<-\EOF &&
> - fatal: bad numeric config value '\''1auto'\'' for '\''aninvalid.unit'\'' in .git/config: invalid unit
> + fatal: bad numeric config value '\''1auto'\'' for '\''aninvalid.unit'\'' in file .git/config: invalid unit
> EOF
> test_must_fail git config --int --get aninvalid.unit 2>actual &&
> test_i18ncmp expect actual
> '
>
> +test_expect_success 'invalid stdin config' '
> + echo "fatal: bad config line 1 in stdin " >expect &&
So, this looks odd. Using the above would give:
fatal: bad config line 1 in file <stdin>
> + echo "[broken" | test_must_fail git config --list --file - >output 2>&1 &&
> + test_cmp expect output
> +'
> +
> cat > expect << EOF
> true
> false
> diff --git a/t/t1308-config-set.sh b/t/t1308-config-set.sh
> index 91235b7..82f82a1 100755
> --- a/t/t1308-config-set.sh
> +++ b/t/t1308-config-set.sh
> @@ -195,14 +195,14 @@ test_expect_success 'proper error on error in default config files' '
> cp .git/config .git/config.old &&
> test_when_finished "mv .git/config.old .git/config" &&
> echo "[" >>.git/config &&
> - echo "fatal: bad config file line 34 in .git/config" >expect &&
> + echo "fatal: bad config line 34 in file .git/config" >expect &&
> test_expect_code 128 test-config get_value foo.bar 2>actual &&
> test_cmp expect actual
> '
>
> test_expect_success 'proper error on error in custom config files' '
> echo "[" >>syntax-error &&
> - echo "fatal: bad config file line 1 in syntax-error" >expect &&
> + echo "fatal: bad config line 1 in file syntax-error" >expect &&
> test_expect_code 128 test-config configset_get_value foo.bar syntax-error 2>actual &&
> test_cmp expect actual
> '
>
ATB,
Ramsay Jones
next prev parent reply other threads:[~2016-02-15 21:30 UTC|newest]
Thread overview: 32+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-02-15 10:17 [PATCH v4 0/3] config: add '--sources' option to print the source of a config value larsxschneider
2016-02-15 10:17 ` [PATCH v4 1/3] t: do not hide Git's exit code in tests larsxschneider
2016-02-15 17:41 ` Jeff King
2016-02-16 9:36 ` Lars Schneider
2016-02-15 10:17 ` [PATCH v4 2/3] config: add 'type' to config_source struct that identifies config type larsxschneider
2016-02-15 17:42 ` Jeff King
2016-02-16 22:07 ` Ramsay Jones
2016-02-15 21:30 ` Ramsay Jones [this message]
2016-02-17 13:12 ` Johannes Schindelin
2016-02-18 8:46 ` Lars Schneider
2016-02-15 10:17 ` [PATCH v4 3/3] config: add '--show-origin' option to print the origin of a config value larsxschneider
2016-02-15 18:06 ` Jeff King
2016-02-15 20:58 ` Eric Sunshine
2016-02-15 21:03 ` Jeff King
2016-02-17 8:32 ` Lars Schneider
2016-02-17 16:39 ` Junio C Hamano
2016-02-15 21:36 ` Ramsay Jones
2016-02-15 21:40 ` Jeff King
2016-02-15 22:39 ` Ramsay Jones
2016-02-16 9:51 ` Lars Schneider
2016-02-16 16:46 ` Ramsay Jones
2016-02-16 17:38 ` Jeff King
2016-02-16 22:14 ` Ramsay Jones
2016-02-16 22:17 ` Jeff King
2016-02-15 21:41 ` Junio C Hamano
2016-02-16 9:48 ` Lars Schneider
2016-02-15 22:18 ` Junio C Hamano
2016-02-15 22:59 ` Jeff King
2016-02-15 23:56 ` Junio C Hamano
2016-02-16 9:52 ` Lars Schneider
2016-02-15 18:05 ` [PATCH v4 0/3] config: add '--sources' option to print the source " Jeff King
2016-02-16 9:40 ` Lars Schneider
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=56C24375.4080007@ramsayjones.plus.com \
--to=ramsay@ramsayjones.plus.com \
--cc=Johannes.Schindelin@gmx.de \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=hvoigt@hvoigt.net \
--cc=larsxschneider@gmail.com \
--cc=peff@peff.net \
--cc=sbeller@google.com \
--cc=sschuberth@gmail.com \
--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).