| Message ID | dddc85bcf54e9b19f1612cf2a5be928dcb2bad7d.1617975637.git.ps@pks.im (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | config: allow overriding global/system config | expand |
On Fri, Apr 09, 2021 at 03:43:25PM +0200, Patrick Steinhardt wrote: > There's two callsites which assemble global config paths, once in the > config loading code and once in the git-config(1) builtin. We're about > to implement a way to override global config paths via an environment > variable which would require us to adjust both sites. > > Unify both code paths into a single `git_global_config()` function which > returns both paths for `~/.gitconfig` and the XDG config file. This will > make the subsequent patch which introduces the new envvar easier to > implement. Seems like a good step forward. There is one minor issue with the implementation, though. > diff --git a/builtin/config.c b/builtin/config.c > index 02ed0b3fe7..604a0973a5 100644 > --- a/builtin/config.c > +++ b/builtin/config.c > @@ -671,9 +671,9 @@ int cmd_config(int argc, const char **argv, const char *prefix) > } > > if (use_global_config) { > - char *user_config = expand_user_path("~/.gitconfig", 0); > - char *xdg_config = xdg_config_home("config"); > + const char *user_config, *xdg_config; > > + git_global_config(&user_config, &xdg_config); The pointer out-parameters make sense here, since we need to return two values. I notice they became const, so the function will hold on to ownership of the memory. > @@ -688,10 +688,8 @@ int cmd_config(int argc, const char **argv, const char *prefix) > if (access_or_warn(user_config, R_OK, 0) && > xdg_config && !access_or_warn(xdg_config, R_OK, 0)) { > given_config_source.file = xdg_config; > - free(user_config); > } else { > given_config_source.file = user_config; > - free(xdg_config); > } ...which is why we drop these free() calls. So far so good. > +void git_global_config(const char **user, const char **xdg) > +{ > + static const char *user_config, *xdg_config; > + > + if (!user_config) { > + user_config = expand_user_path("~/.gitconfig", 0); > + xdg_config = xdg_config_home("config"); > + } > + > + *user = user_config; > + *xdg = xdg_config; > +} And here in the implementation we hold on to the static values forever. I think your "did we initialize already" check isn't robust, though. expand_user_path() can return NULL, in which case every call would trigger a re-initialization (even leaking xdg_config if it was set in the last round). So I think you'd need a separate "static int initialized" variable. That said, I wonder if we should just pass ownership of the memory to the caller. It is a minor inconvenience that they will have to free() the result, but we're already doing that. And it removes any possibility of thread unsafety. I guess it doesn't match git_system_config() as well, then. But arguably it should also just pass ownership (it also has only a handful of callers, and freeing the result would not be a big deal). I'm OK with either solution, though. -Peff
diff --git a/builtin/config.c b/builtin/config.c index 02ed0b3fe7..604a0973a5 100644 --- a/builtin/config.c +++ b/builtin/config.c @@ -671,9 +671,9 @@ int cmd_config(int argc, const char **argv, const char *prefix) } if (use_global_config) { - char *user_config = expand_user_path("~/.gitconfig", 0); - char *xdg_config = xdg_config_home("config"); + const char *user_config, *xdg_config; + git_global_config(&user_config, &xdg_config); if (!user_config) /* * It is unknown if HOME/.gitconfig exists, so @@ -688,10 +688,8 @@ int cmd_config(int argc, const char **argv, const char *prefix) if (access_or_warn(user_config, R_OK, 0) && xdg_config && !access_or_warn(xdg_config, R_OK, 0)) { given_config_source.file = xdg_config; - free(user_config); } else { given_config_source.file = user_config; - free(xdg_config); } } else if (use_system_config) { diff --git a/config.c b/config.c index c552ab4ad9..6af0244085 100644 --- a/config.c +++ b/config.c @@ -1852,6 +1852,19 @@ const char *git_system_config(void) return system_wide; } +void git_global_config(const char **user, const char **xdg) +{ + static const char *user_config, *xdg_config; + + if (!user_config) { + user_config = expand_user_path("~/.gitconfig", 0); + xdg_config = xdg_config_home("config"); + } + + *user = user_config; + *xdg = xdg_config; +} + /* * Parse environment variable 'k' as a boolean (in various * possible spellings); if missing, use the default value 'def'. @@ -1883,9 +1896,8 @@ static int do_git_config_sequence(const struct config_options *opts, config_fn_t fn, void *data) { int ret = 0; - char *xdg_config = xdg_config_home("config"); - char *user_config = expand_user_path("~/.gitconfig", 0); char *repo_config; + const char *user_config, *xdg_config; enum config_scope prev_parsing_scope = current_parsing_scope; if (opts->commondir) @@ -1903,6 +1915,8 @@ static int do_git_config_sequence(const struct config_options *opts, data); current_parsing_scope = CONFIG_SCOPE_GLOBAL; + git_global_config(&user_config, &xdg_config); + if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) ret += git_config_from_file(fn, xdg_config, data); @@ -1927,8 +1941,6 @@ static int do_git_config_sequence(const struct config_options *opts, die(_("unable to parse command-line config")); current_parsing_scope = prev_parsing_scope; - free(xdg_config); - free(user_config); free(repo_config); return ret; } diff --git a/config.h b/config.h index 8e8376ae19..53a782e0f5 100644 --- a/config.h +++ b/config.h @@ -327,6 +327,7 @@ int config_error_nonbool(const char *); #endif const char *git_system_config(void); +void git_global_config(const char **user, const char **xdg); int git_config_parse_parameter(const char *, config_fn_t fn, void *data);
There's two callsites which assemble global config paths, once in the config loading code and once in the git-config(1) builtin. We're about to implement a way to override global config paths via an environment variable which would require us to adjust both sites. Unify both code paths into a single `git_global_config()` function which returns both paths for `~/.gitconfig` and the XDG config file. This will make the subsequent patch which introduces the new envvar easier to implement. No functional changes are expected from this patch. Signed-off-by: Patrick Steinhardt <ps@pks.im> --- builtin/config.c | 6 ++---- config.c | 20 ++++++++++++++++---- config.h | 1 + 3 files changed, 19 insertions(+), 8 deletions(-)