Skip to content

Commit 3b57363

Browse files
committed
Windows: add support for a Windows-wide configuration
Between the libgit2 and the Git for Windows project, there has been a discussion how we could share Git configuration to avoid duplication (or worse: skew). Earlier, libgit2 was nice enough to just re-use Git for Windows' C:\Program Files (x86)\Git\etc\gitconfig but with the upcoming Git for Windows 2.x, there would be more paths to search, as we will have 64-bit and 32-bit versions, and the corresponding config files will be in %PROGRAMFILES%\Git\mingw64\etc and ...\mingw32\etc, respectively. Worse: there are portable Git for Windows versions out there which live in totally unrelated directories, still. Therefore we came to a consensus to use `%PROGRAMDATA%\Git\config` as the location for shared Git settings that are of wider interest than just Git for Windows. Of course, the configuration in `%PROGRAMDATA%\Git\config` has the widest reach, therefore it must take the lowest precedence, i.e. Git for Windows can still override settings in its `etc/gitconfig` file. Helped-by: Andreas Heiduk <[email protected]> Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 27e3e78 commit 3b57363

File tree

7 files changed

+43
-5
lines changed

7 files changed

+43
-5
lines changed

Documentation/config.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ the Git commands' behavior. The files `.git/config` and optionally
77
repository are used to store the configuration for that repository, and
88
`$HOME/.gitconfig` is used to store a per-user configuration as
99
fallback values for the `.git/config` file. The file `/etc/gitconfig`
10-
can be used to store a system-wide default configuration.
10+
can be used to store a system-wide default configuration. On Windows,
11+
configuration can also be stored in `C:\ProgramData\Git\config`; This
12+
file will be used also by libgit2-based software.
1113

1214
The configuration variables are used by both the Git plumbing
1315
and the porcelains. The variables are divided into sections, wherein

Documentation/git-config.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -270,8 +270,16 @@ FILES
270270
If not set explicitly with `--file`, there are four files where
271271
'git config' will search for configuration options:
272272

273+
$PROGRAMDATA/Git/config::
274+
(Windows-only) System-wide configuration file shared with other Git
275+
implementations. Typically `$PROGRAMDATA` points to `C:\ProgramData`.
276+
273277
$(prefix)/etc/gitconfig::
274278
System-wide configuration file.
279+
(Windows-only) This file contains only the settings which are
280+
specific for this installation of Git for Windows and which should
281+
not be shared with other Git implementations like JGit, libgit2.
282+
`--system` will select this file.
275283

276284
$XDG_CONFIG_HOME/git/config::
277285
Second user-specific configuration file. If $XDG_CONFIG_HOME is not set

Documentation/git.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -567,7 +567,8 @@ for further details.
567567

568568
`GIT_CONFIG_NOSYSTEM`::
569569
Whether to skip reading settings from the system-wide
570-
`$(prefix)/etc/gitconfig` file. This environment variable can
570+
`$(prefix)/etc/gitconfig` file (and on Windows, also from the
571+
`%PROGRAMDATA%\Git\config` file). This environment variable can
571572
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
572573
predictable environment for a picky script, or you can set it
573574
temporarily to avoid using a buggy `/etc/gitconfig` file while

compat/mingw.c

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2563,3 +2563,17 @@ int uname(struct utsname *buf)
25632563
"%u", (v >> 16) & 0x7fff);
25642564
return 0;
25652565
}
2566+
2567+
const char *program_data_config(void)
2568+
{
2569+
static struct strbuf path = STRBUF_INIT;
2570+
static unsigned initialized;
2571+
2572+
if (!initialized) {
2573+
const char *env = mingw_getenv("PROGRAMDATA");
2574+
if (env)
2575+
strbuf_addf(&path, "%s/Git/config", env);
2576+
initialized = 1;
2577+
}
2578+
return *path.buf ? path.buf : NULL;
2579+
}

compat/mingw.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -472,6 +472,8 @@ int mingw_offset_1st_component(const char *path);
472472
#define PATH_SEP ';'
473473
extern char *mingw_query_user_email(void);
474474
#define query_user_email mingw_query_user_email
475+
extern const char *program_data_config(void);
476+
#define git_program_data_config program_data_config
475477
#if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
476478
#define PRIuMAX "I64u"
477479
#define PRId64 "I64d"

config.c

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1674,9 +1674,16 @@ static int do_git_config_sequence(const struct config_options *opts,
16741674
repo_config = NULL;
16751675

16761676
current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1677-
if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1678-
ret += git_config_from_file(fn, git_etc_gitconfig(),
1679-
data);
1677+
if (git_config_system()) {
1678+
if (git_program_data_config() &&
1679+
!access_or_die(git_program_data_config(), R_OK, 0))
1680+
ret += git_config_from_file(fn,
1681+
git_program_data_config(),
1682+
data);
1683+
if (!access_or_die(git_etc_gitconfig(), R_OK, 0))
1684+
ret += git_config_from_file(fn, git_etc_gitconfig(),
1685+
data);
1686+
}
16801687

16811688
current_parsing_scope = CONFIG_SCOPE_GLOBAL;
16821689
if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))

git-compat-util.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,10 @@ static inline char *git_find_last_dir_sep(const char *path)
397397
#define query_user_email() NULL
398398
#endif
399399

400+
#ifndef git_program_data_config
401+
#define git_program_data_config() NULL
402+
#endif
403+
400404
#if defined(__HP_cc) && (__HP_cc >= 61000)
401405
#define NORETURN __attribute__((noreturn))
402406
#define NORETURN_PTR

0 commit comments

Comments
 (0)