From: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
To: Glen Choo via GitGitGadget <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Jonathan Tan <jonathantanmy@google.com>,
Emily Shaffer <nasamuffin@google.com>,
Glen Choo <chooglen@google.com>
Subject: Re: [PATCH 10/14] (RFC-only) config: finish config_fn_t refactor
Date: Mon, 01 May 2023 13:19:48 +0200 [thread overview]
Message-ID: <230501.868re8jna4.gmgdl@evledraar.gmail.com> (raw)
In-Reply-To: <1071e70c92892166e1ed2cf22bcd7eb49bdf3b20.1682104399.git.gitgitgadget@gmail.com>
On Fri, Apr 21 2023, Glen Choo via GitGitGadget wrote:
> From: Glen Choo <chooglen@google.com>
I like the general goal of this series, i.e. to get rid of the "reader"
callback, and pass stuff more explicitly.
But as I pointed out in
https://lore.kernel.org/git/RFC-cover-0.5-00000000000-20230317T042408Z-avarab@gmail.com/
I think this part (and the preceding two commits) are really taking is
down the wrong path.
To demonstrate why, here's a patch-on-top of this topic as a whole where
I renamed the "kvi" struct members. I've excluded config.c itself (as
its internals aren't interesting for the purposes of this discussion):
diff --git a/builtin/config.c b/builtin/config.c
index c9e80a4b500..00cf8ffd791 100644
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -198,8 +198,8 @@ static void show_config_origin(struct key_value_info *kvi, struct strbuf *buf)
- strbuf_addstr(buf, config_origin_type_name(kvi->origin_type));
+ strbuf_addstr(buf, config_origin_type_name(kvi->origin_type2));
strbuf_addch(buf, ':');
if (end_nul)
- strbuf_addstr(buf, kvi->filename ? kvi->filename : "");
+ strbuf_addstr(buf, kvi->filename2 ? kvi->filename2 : "");
else
- quote_c_style(kvi->filename ? kvi->filename : "", buf, NULL, 0);
+ quote_c_style(kvi->filename2 ? kvi->filename2 : "", buf, NULL, 0);
strbuf_addch(buf, term);
@@ -210,3 +210,3 @@ static void show_config_scope(struct key_value_info *kvi, struct strbuf *buf)
const char term = end_nul ? '\0' : '\t';
- const char *scope = config_scope_name(kvi->scope);
+ const char *scope = config_scope_name(kvi->scope2);
diff --git a/builtin/remote.c b/builtin/remote.c
index 034998a1205..81922af3f58 100644
--- a/builtin/remote.c
+++ b/builtin/remote.c
@@ -655,6 +655,6 @@ static int config_read_push_default(const char *key, const char *value,
- info->scope = kvi->scope;
+ info->scope = kvi->scope2;
strbuf_reset(&info->origin);
- strbuf_addstr(&info->origin, kvi->filename);
- info->linenr = kvi->linenr;
+ strbuf_addstr(&info->origin, kvi->filename2);
+ info->linenr = kvi->linenr2;
diff --git a/config.h b/config.h
index ffb2d76823c..d9b0470e7b7 100644
--- a/config.h
+++ b/config.h
@@ -120,8 +120,8 @@ struct config_options {
struct key_value_info {
- const char *filename;
- int linenr;
- enum config_origin_type origin_type;
- enum config_scope scope;
- const char *path;
- struct key_value_info *prev;
+ const char *filename2;
+ int linenr2;
+ enum config_origin_type origin_type2;
+ enum config_scope scope2;
+ const char *path2;
+ struct key_value_info *prev2;
};
diff --git a/remote.c b/remote.c
index 5239dfeab55..1cb465c6c17 100644
--- a/remote.c
+++ b/remote.c
@@ -417,4 +417,4 @@ static int handle_config(const char *key, const char *value,
remote->origin = REMOTE_CONFIG;
- if (kvi->scope == CONFIG_SCOPE_LOCAL ||
- kvi->scope == CONFIG_SCOPE_WORKTREE)
+ if (kvi->scope2 == CONFIG_SCOPE_LOCAL ||
+ kvi->scope2 == CONFIG_SCOPE_WORKTREE)
remote->configured_in_repo = 1;
diff --git a/t/helper/test-config.c b/t/helper/test-config.c
index 737505583d4..fa89cdd084c 100644
--- a/t/helper/test-config.c
+++ b/t/helper/test-config.c
@@ -54,6 +54,6 @@ static int iterate_cb(const char *var, const char *value,
printf("value=%s\n", value ? value : "(null)");
- printf("origin=%s\n", config_origin_type_name(kvi->origin_type));
- printf("name=%s\n", kvi->filename ? kvi->filename : "");
- printf("lno=%d\n", kvi->linenr);
- printf("scope=%s\n", config_scope_name(kvi->scope));
+ printf("origin=%s\n", config_origin_type_name(kvi->origin_type2));
+ printf("name=%s\n", kvi->filename2 ? kvi->filename2 : "");
+ printf("lno=%d\n", kvi->linenr2);
+ printf("scope=%s\n", config_scope_name(kvi->scope2));
diff --git a/trace2/tr2_tgt_event.c b/trace2/tr2_tgt_event.c
index 83db3c755bd..338c5a58bd9 100644
--- a/trace2/tr2_tgt_event.c
+++ b/trace2/tr2_tgt_event.c
@@ -482,3 +482,3 @@ static void fn_param_fl(const char *file, int line, const char *param,
struct json_writer jw = JSON_WRITER_INIT;
- enum config_scope scope = kvi->scope;
+ enum config_scope scope = kvi->scope2;
const char *scope_name = config_scope_name(scope);
diff --git a/trace2/tr2_tgt_normal.c b/trace2/tr2_tgt_normal.c
index 65e9be9c5a4..5a06042e7c3 100644
--- a/trace2/tr2_tgt_normal.c
+++ b/trace2/tr2_tgt_normal.c
@@ -301,3 +301,3 @@ static void fn_param_fl(const char *file, int line, const char *param,
struct strbuf buf_payload = STRBUF_INIT;
- enum config_scope scope = kvi->scope;
+ enum config_scope scope = kvi->scope2;
const char *scope_name = config_scope_name(scope);
diff --git a/trace2/tr2_tgt_perf.c b/trace2/tr2_tgt_perf.c
index f402f6e3813..96fa359183d 100644
--- a/trace2/tr2_tgt_perf.c
+++ b/trace2/tr2_tgt_perf.c
@@ -445,3 +445,3 @@ static void fn_param_fl(const char *file, int line, const char *param,
struct strbuf scope_payload = STRBUF_INIT;
- enum config_scope scope = kvi->scope;
+ enum config_scope scope = kvi->scope2;
const char *scope_name = config_scope_name(scope);
So, as this shows us your 08/14 has gone through the effort of passing
this "kvi" info to every single callback, but it's only this handful
that actually needs this information.
So, even if we *can* get this to work I don't think it's worth it,
especially as this would preclude giving these config callbacks some
"lighter" API that doesn't take the trouble of recording and ferrying
this information to them.
Of course *now* we need to always prepare this information anyway, as
anyone could access it via a global, but as the work you've done here
shows we're always doing that, but only need it for these few cases.
So I really think we could leave the vast majority of the current
callbacks alone, and just supply a new "kvi" callback. My
https://lore.kernel.org/git/RFC-patch-5.5-2b80d293c83-20230317T042408Z-avarab@gmail.com/
showed one way forward with that.
I think this should also neatly answer some of your outstanding
questions. Especially as the above shows that the only non-test caller
that needs "linenr" is the builtin/config.c caller that my proposed RFC
(linked above) tackled directly. Most of these callbacks just need the
more basic "scope".
So, in particular:
> Here's an exhaustive list of all of the changes:
>
> * Cases that need a judgement call
>
> - trace2/tr2_cfg.c:tr2_cfg_set_fl()
>
> This function needs to account for tr2_cfg_cb() now using "kvi".
> Since this is only called (indirectly) by git_config_set(), config
> source information has never been available here, so just pass NULL.
> It will be tr2_cfg_cb()'s responsibility to not use "kvi".
Just adding a "CONFIG_SCOPE_IN_PROCESS", "CONFIG_SCOPE_SET" or whatever
you'd want to call it seems to make much more sense here, no?
> - builtin/checkout.c:checkout_main()
>
> This calls git_xmerge_config() as a shorthand for parsing a CLI arg.
> "kvi" doesn't apply, so just pass NULL. This might be worth
> refactoring away, since git_xmerge_config() can call
> git_default_config().
Another example of a caller which never actually cares about this data,
so if it doesn't need to have it passed to it, it doesn't need to fake
it up either.
> - config.c:git_config_include()
>
> Replace the local "kvi" variable with the "kvi" parameter. This
> makes config_include_data.config_reader obsolete, so remove it.
No comment (internal to config.c, as noted above).
> * Hard for cocci to catch
>
> - urlmatch.c
>
> Manually refactor the custom config callbacks in "struct
> urlmatch_config".
>
> - diff.h, fsck.h, grep.h, ident.h, xdiff-interface.h
>
> "struct key_value_info" hasn't been defined yet, so forward declare
> it. Alternatively, maybe these files should "#include config.h".
All of these problems go away if you don't insist on changing every
single caller, you'll just have a step where you remove the current
global in favor of some "config callback with kvi" info, and "make" will
spot those callers that aren't converted yet.
Those changes will be trivial enough (just the callers I noted above) to
not require the tricky cocci patch in 08/14.
> * Likely deficiencies in .cocci patch
>
> - submodule-config.c:gitmodules_cb()
>
> Manually refactor a parse_config() call that gets missed because it
> uses a different "*data" arg.
>
> - grep.h, various
>
> Manually refactor grep_config() calls. Not sure why these don't get
> picked up.
>
> - config.c:git_config_include(), http.c:http_options()
>
> Manually add "kvi" where it was missed. Not sure why they get missed.
>
> - builtin/clone.c:write_one_config()
>
> Manually refactor a git_clone_config() call. Probably got missed
> because I didn't include git_config_parse_parameter().
>
> - ident.h
>
> Remove the UNUSED attribute. Not sure why this is the only instance
> of this.
>
> - git-compat-util.h, compat/mingw.[h|c]
>
> Manually refactor noop_core_config(), platform_core_config() and
> mingw_core_config(). I can probably add these as "manual fixups" in
> cocci.
ditto.
next prev parent reply other threads:[~2023-05-01 11:37 UTC|newest]
Thread overview: 115+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-21 19:13 [PATCH 00/14] [RFC] config: remove global state from config iteration Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 01/14] config.c: introduce kvi_fn(), use it for configsets Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 02/14] config.c: use kvi for CLI config Glen Choo via GitGitGadget
2023-05-01 11:06 ` Ævar Arnfjörð Bjarmason
2023-04-21 19:13 ` [PATCH 03/14] config: use kvi for config files Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 04/14] config: add kvi.path, use it to evaluate includes Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 05/14] config: pass source to config_parser_event_fn_t Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 06/14] config: inline git_color_default_config Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 07/14] urlmatch.h: use config_fn_t type Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 08/14] (RFC-only) config: add kvi arg to config_fn_t Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 09/14] (RFC-only) config: apply cocci to config_fn_t implementations Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 10/14] (RFC-only) config: finish config_fn_t refactor Glen Choo via GitGitGadget
2023-05-01 11:19 ` Ævar Arnfjörð Bjarmason [this message]
2023-05-05 21:07 ` Jonathan Tan
2023-05-09 22:46 ` Glen Choo
2023-05-11 16:21 ` Jonathan Tan
2023-05-08 21:00 ` Glen Choo
2023-04-21 19:13 ` [PATCH 11/14] config: remove current_config_(line|name|origin_type) Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 12/14] config: remove current_config_scope() Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 13/14] config: pass kvi to die_bad_number() Glen Choo via GitGitGadget
2023-04-21 19:13 ` [PATCH 14/14] config: remove config_reader from configset_add_value Glen Choo via GitGitGadget
2023-05-30 18:41 ` [PATCH v2 00/14] [RFC] config: remove global state from config iteration Glen Choo via GitGitGadget
2023-05-30 18:41 ` [PATCH v2 01/14] config: inline git_color_default_config Glen Choo via GitGitGadget
2023-05-30 18:42 ` [PATCH v2 02/14] urlmatch.h: use config_fn_t type Glen Choo via GitGitGadget
2023-05-30 18:42 ` [PATCH v2 03/14] (RFC-only) config: add kvi arg to config_fn_t Glen Choo via GitGitGadget
2023-06-01 9:50 ` Phillip Wood
2023-06-01 16:22 ` Glen Choo
2023-06-02 9:54 ` Phillip Wood
2023-06-02 16:46 ` Glen Choo
2023-06-05 9:38 ` Phillip Wood
2023-06-09 23:19 ` Glen Choo
2023-05-30 18:42 ` [PATCH v2 04/14] (RFC-only) config: apply cocci to config_fn_t implementations Glen Choo via GitGitGadget
2023-05-30 18:42 ` [PATCH v2 05/14] (RFC-only) config: finish config_fn_t refactor Glen Choo via GitGitGadget
2023-06-01 22:17 ` Jonathan Tan
2023-05-30 18:42 ` [PATCH v2 06/14] config.c: pass kvi in configsets Glen Choo via GitGitGadget
2023-06-01 22:21 ` Jonathan Tan
2023-05-30 18:42 ` [PATCH v2 07/14] config: provide kvi with config files Glen Choo via GitGitGadget
2023-06-01 22:41 ` Jonathan Tan
2023-06-01 23:54 ` Jonathan Tan
2023-05-30 18:42 ` [PATCH v2 08/14] builtin/config.c: test misuse of format_config() Glen Choo via GitGitGadget
2023-05-30 18:42 ` [PATCH v2 09/14] config.c: provide kvi with CLI config Glen Choo via GitGitGadget
2023-06-01 23:35 ` Jonathan Tan
2023-06-02 17:26 ` Glen Choo
2023-05-30 18:42 ` [PATCH v2 10/14] trace2: plumb config kvi Glen Choo via GitGitGadget
2023-06-01 23:38 ` Jonathan Tan
2023-05-30 18:42 ` [PATCH v2 11/14] config: pass kvi to die_bad_number() Glen Choo via GitGitGadget
2023-06-01 23:48 ` Jonathan Tan
2023-06-02 17:23 ` Glen Choo
2023-05-30 18:42 ` [PATCH v2 12/14] config.c: remove config_reader from configsets Glen Choo via GitGitGadget
2023-05-30 18:42 ` [PATCH v2 13/14] config: add kvi.path, use it to evaluate includes Glen Choo via GitGitGadget
2023-06-02 0:06 ` Jonathan Tan
2023-05-30 18:42 ` [PATCH v2 14/14] config: pass source to config_parser_event_fn_t Glen Choo via GitGitGadget
2023-06-02 0:08 ` Jonathan Tan
2023-06-02 17:20 ` Glen Choo
2023-06-20 19:43 ` [PATCH v3 00/12] config: remove global state from config iteration Glen Choo via GitGitGadget
2023-06-20 19:43 ` [PATCH v3 01/12] config: inline git_color_default_config Glen Choo via GitGitGadget
2023-06-20 21:01 ` Junio C Hamano
2023-06-20 19:43 ` [PATCH v3 02/12] urlmatch.h: use config_fn_t type Glen Choo via GitGitGadget
2023-06-20 21:02 ` Junio C Hamano
2023-06-20 19:43 ` [PATCH v3 03/12] config: add ctx arg to config_fn_t Glen Choo via GitGitGadget
2023-06-20 19:43 ` [PATCH v3 04/12] config.c: pass ctx in configsets Glen Choo via GitGitGadget
2023-06-20 21:19 ` Junio C Hamano
2023-06-20 19:43 ` [PATCH v3 05/12] config: pass ctx with config files Glen Choo via GitGitGadget
2023-06-20 19:43 ` [PATCH v3 06/12] builtin/config.c: test misuse of format_config() Glen Choo via GitGitGadget
2023-06-20 21:35 ` Junio C Hamano
2023-06-20 23:06 ` Glen Choo
2023-06-23 20:32 ` Jonathan Tan
2023-06-24 1:31 ` Jeff King
2023-06-28 17:28 ` Glen Choo
2023-06-20 19:43 ` [PATCH v3 07/12] config.c: pass ctx with CLI config Glen Choo via GitGitGadget
2023-06-23 20:35 ` Jonathan Tan
2023-06-23 21:41 ` Glen Choo
2023-06-20 19:43 ` [PATCH v3 08/12] trace2: plumb config kvi Glen Choo via GitGitGadget
2023-06-23 20:40 ` Jonathan Tan
2023-06-20 19:43 ` [PATCH v3 09/12] config: pass kvi to die_bad_number() Glen Choo via GitGitGadget
2023-06-20 19:43 ` [PATCH v3 10/12] config.c: remove config_reader from configsets Glen Choo via GitGitGadget
2023-06-23 20:57 ` Jonathan Tan
2023-06-23 21:33 ` Junio C Hamano
2023-06-20 19:43 ` [PATCH v3 11/12] config: add kvi.path, use it to evaluate includes Glen Choo via GitGitGadget
2023-06-20 19:43 ` [PATCH v3 12/12] config: pass source to config_parser_event_fn_t Glen Choo via GitGitGadget
2023-06-20 21:46 ` Junio C Hamano
2023-06-21 21:46 ` [PATCH v3 00/12] config: remove global state from config iteration Junio C Hamano
2023-06-21 23:06 ` Glen Choo
2023-06-23 21:02 ` Jonathan Tan
2023-06-23 21:33 ` Junio C Hamano
2023-06-23 21:45 ` Glen Choo
2023-06-26 18:11 ` [PATCH v4 " Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 01/12] config: inline git_color_default_config Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 02/12] urlmatch.h: use config_fn_t type Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 03/12] config: add ctx arg to config_fn_t Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 04/12] config.c: pass ctx in configsets Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 05/12] config: pass ctx with config files Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 06/12] builtin/config.c: test misuse of format_config() Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 07/12] config.c: pass ctx with CLI config Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 08/12] trace2: plumb config kvi Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 09/12] config: pass kvi to die_bad_number() Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 10/12] config.c: remove config_reader from configsets Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 11/12] config: add kvi.path, use it to evaluate includes Glen Choo via GitGitGadget
2023-06-26 18:11 ` [PATCH v4 12/12] config: pass source to config_parser_event_fn_t Glen Choo via GitGitGadget
2023-06-26 20:45 ` [PATCH v4 00/12] config: remove global state from config iteration Junio C Hamano
2023-06-28 19:26 ` [PATCH v5 00/11] " Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 01/11] config: inline git_color_default_config Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 02/11] urlmatch.h: use config_fn_t type Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 03/11] config: add ctx arg to config_fn_t Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 04/11] config.c: pass ctx in configsets Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 05/11] config: pass ctx with config files Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 06/11] config.c: pass ctx with CLI config Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 07/11] trace2: plumb config kvi Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 08/11] config: pass kvi to die_bad_number() Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 09/11] config.c: remove config_reader from configsets Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 10/11] config: add kvi.path, use it to evaluate includes Glen Choo via GitGitGadget
2023-06-28 19:26 ` [PATCH v5 11/11] config: pass source to config_parser_event_fn_t Glen Choo via GitGitGadget
2023-06-28 22:23 ` [PATCH v5 00/11] config: remove global state from config iteration Jonathan Tan
2023-06-28 22:47 ` Junio C Hamano
2023-07-11 18:41 ` Phillip Wood
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=230501.868re8jna4.gmgdl@evledraar.gmail.com \
--to=avarab@gmail.com \
--cc=chooglen@google.com \
--cc=git@vger.kernel.org \
--cc=gitgitgadget@gmail.com \
--cc=jonathantanmy@google.com \
--cc=nasamuffin@google.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.
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).