Skip to content

config: read both home and xdg files for --global

Delilah Ashley Wu via GitGitGadget git 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest4 patches 10 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4cleanup_path: force forward slashes on Windowspath.c+7 -31 reply
2/4config: test home and xdg files in `list --global`t/t1300-config.sh t/t1306-xdg-files.sh+68 -21 reply
3/4config: read global scope via config_sequencebuiltin/config.c config.c config.h +2 more+33 -151 reply
4/4config: keep bailing on unreadable global filesconfig.c t/t1300-config.sh+33 -110 replies

Reviews trailers per patch

All 4 patches have a Reviewed-by or Acked-by.

PatchJohannes SchindelinDerrick Stolee
SeriesHelped-by Helped-by Helped-by Helped-by
1/4R-b
2/4R-b Helped-by
3/4R-b Helped-by
4/4R-b Helped-by

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes.

Read the v1 thread

Cover letter [PATCH/RFC 0/4] config: read both home and xdg files for --global

Hi!

As reported in [1]: $HOME/.gitconfig and $XDG_CONFIG_HOME/git/config are both valid global config locations, but git config list --global only includes the former in its output.

Suppose we have this config in $HOME/.gitconfig:

[home]
config = true

And this config in $XDG_CONFIG_HOME/git/config:

[xdg]
config = true

Then, to reproduce the issue that --global only shows the home config:

$ git config list --global --show-scope --show-origin
global  file:/Users/delilah/.gitconfig    home.config=true

Git correctly applies the XDG config in its effective configuration, but it doesn't show up when --global is specified. We can confirm this by checking the output without the --global flag:

$ git config list --show-scope --show-origin
global  file:/Users/delilah/.config/git/config    xdg.config=true
global  file:/Users/delilah/.gitconfig            home.config=true

The expected behaviour is both configs should be shown when --global is specified, so we'd expect its output to look the same as above. This was confirmed in [2], which quoted the git config documentation:

Quoted 9 lines

OPTIONS
--global::
For writing options: write to global ~/.gitconfig file rather than the repository .git/config, write to $XDG_CONFIG_HOME/git/config file if this file exists and the ~/.gitconfig file doesn't.

For reading options: read only from global ~/.gitconfig and from $XDG_CONFIG_HOME/git/config rather than from all available files.

The first patch fixes forward slash normalisation on Windows paths. The second patch introduces tests and regression checks. The third and fourth patches implement the fix to include both config files when --global is specified. Johannes has kindly pre-reviewed this patch series via GitHub on GitGitGadget #1938 [3]. You'll notice some force-pushes after the review, but I only changed commit messages.

[1]:
https://lore.kernel.org/git/CAFA9we-QLQRzJdGMMCPatmfrk1oHeiUu9msMRXXk1MLE5HRxBQ@mail.gmail.com/
[2]: https://lore.kernel.org/git/[email protected]/
[3]: https://github.com/gitgitgadget/git/pull/1938/

Thank you all for your time!
Delilah

Delilah Ashley Wu (4):
cleanup_path: force forward slashes on Windows
config: test home and xdg files in list --global
config: read global scope via config_sequence
config: keep bailing on unreadable global files

 builtin/config.c     | 12 ++++++++
 config.c             | 54 ++++++++++++++++++++++++++----------
 config.h             |  2 ++
 path.c               | 10 +++++--
 t/t1300-config.sh    | 65 ++++++++++++++++++++++++++++++++++++++++++++
 t/t1306-xdg-files.sh |  3 +-
 6 files changed, 128 insertions(+), 18 deletions(-)

base-commit: ca2559c1d630eb4f04cdee2328aaf1c768907a9e
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-1938%2Fdelilahw%2Flilah%2Ffix-config-list-global-home-and-xdg%2Fpatchset-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-1938/delilahw/lilah/fix-config-list-global-home-and-xdg/patchset-v1
Pull-Request: https://github.com/gitgitgadget/git/pull/1938

Signature · 1 line
gitgitgadget