kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

path: use forward slashes in XDG config on Windows 

Git prefers forward slashes as directory separators across all
platforms. On Windows, the backslash is the native directory separator,
but all Windows versions supported by Git also accept the forward slash
in all but rare circumstances. Our tests expect forward slashes. Git
displays relative paths with forward slashes. Forward slashes are more
convenient to use in shell scripts.

For these reasons, we enforced forward slashes in `interpolate_path()`
in 5ca6b7bb47 (config --show-origin: report paths with forward slashes,
2016-03-23). However, other code paths may construct paths containing
backslashes. For example, `config --show-origin` prints the XDG config
path with mixed slashes on Windows:

    $ git config --list --show-origin
    file:C:/Program Files/Git/etc/gitconfig         system.foo=bar
    file:"C:\\Users\\delilah/.config/git/config"    xdg.foo=bar
    file:C:/Users/delilah/.gitconfig                home.foo=bar
    file:.git/config                                local.foo=bar

These mixed slashes occur because the `$HOME` and `$XDG_CONFIG_HOME`
environment variables usually contain backslashes on Windows, and
`xdg_config_home_for()` interpolates them into templates that use
hardcoded forward slashes.

Since callers of `xdg_config_home_for()` handle mixed slashes correctly,
it is reasonable to assume that they can handle paths with only forward
slashes. Let's enforce forward slashes in `xdg_config_home_for()` by
using `convert_slashes()` on Windows.

Also, there are no tests for the XDG path with `--show-origin`. Add a
test for slash conversion and a confidence check for the default path.

Signed-off-by: Delilah Ashley Wu <delilahwu@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
jch
Delilah Ashley Wu 2026-08-23 20:28:26 +10:00 committed by Junio C Hamano
parent 593c42fe07
commit f0a16901bd
2 changed files with 42 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
path.c
View File

@ -1544,19 +1544,23 @@ int looks_like_command_line_option(const char *str)

char *xdg_config_home_for(const char *subdir, const char *filename)
{
char *ret;
const char *home, *config_home;

assert(subdir);
assert(filename);
config_home = getenv("XDG_CONFIG_HOME");
if (config_home && *config_home)
return mkpathdup("%s/%s/%s", config_home, subdir, filename);
ret = mkpathdup("%s/%s/%s", config_home, subdir, filename);
else if ((home = getenv("HOME")))
ret = mkpathdup("%s/.config/%s/%s", home, subdir, filename);
else
return NULL;

home = getenv("HOME");
if (home)
return mkpathdup("%s/.config/%s/%s", home, subdir, filename);

return NULL;
#ifdef GIT_WINDOWS_NATIVE
convert_slashes(ret);
#endif
return ret;
}

char *xdg_config_home(const char *filename)

32
t/t1300-config.sh
View File

@ -2350,6 +2350,38 @@ test_expect_success '--show-origin with --default' '
test_cmp expect actual
'

test_expect_success 'set up xdg config --show-origin tests' '
mkdir -p "$HOME"/.config/git &&
cat >"$HOME"/.config/git/config <<-EOF
[xdg]
config = true
EOF
'

test_expect_success MINGW '--show-origin converts backslashes in xdg path to forward slashes on Windows' '
backslash_home="$(echo "$HOME" | tr / \\\\)" &&
echo "file:$HOME/.config/git/config true" >expect &&

(
sane_unset XDG_CONFIG_HOME &&
HOME="$backslash_home" git config ${mode_get} --show-origin xdg.config >actual
) &&
test_cmp expect actual &&

XDG_CONFIG_HOME="$backslash_home\\.config" git config ${mode_get} --show-origin xdg.config >actual &&
test_cmp expect actual
'

test_expect_success '--show-origin with default xdg path' '
echo "file:$HOME/.config/git/config true" >expect &&
git config ${mode_get} --show-origin xdg.config >actual &&
test_cmp expect actual
'

test_expect_success 'clean up xdg config --show-origin tests' '
rm -rf "$HOME"/.config/git
'

test_expect_success '--show-scope with --list' '
cat >expect <<-EOF &&
global user.global=true