Skip to content

Commit 517b924

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. On XP, there is no %PROGRAMDATA%, therefore we need to use "%ALLUSERSPROFILE%\Application Data\Git\config" in those setups. 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. Signed-off-by: Johannes Schindelin <[email protected]>
1 parent 30a0e13 commit 517b924

File tree

7 files changed

+39
-3
lines changed

7 files changed

+39
-3
lines changed

Documentation/config.txt

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

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

Documentation/git-config.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,11 @@ $XDG_CONFIG_HOME/git/config::
253253
$GIT_DIR/config::
254254
Repository specific configuration file.
255255

256+
On Windows, as there is no central `/etc/` directory, there is yet another
257+
config file, intended to contain settings for *all* Git-related software
258+
running on the machine. Consequently, this config file takes an even lower
259+
precedence than the `$(prefix)/etc/gitconfig` file.
260+
256261
If no further options are given, all reading options will read all of these
257262
files that are available. If the global or the system-wide configuration
258263
file are not available they will be ignored. If the repository configuration

Documentation/git.txt

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

10011001
'GIT_CONFIG_NOSYSTEM'::
10021002
Whether to skip reading settings from the system-wide
1003-
`$(prefix)/etc/gitconfig` file. This environment variable can
1003+
`$(prefix)/etc/gitconfig` file (and on Windows, also from the
1004+
`%PROGRAMDATA%\Git\config` file). This environment variable can
10041005
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
10051006
predictable environment for a picky script, or you can set it
10061007
temporarily to avoid using a buggy `/etc/gitconfig` file while

compat/mingw.c

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2477,3 +2477,22 @@ int uname(struct utsname *buf)
24772477
"%u", (v >> 16) & 0x7fff);
24782478
return 0;
24792479
}
2480+
2481+
const char *program_data_config(void)
2482+
{
2483+
static struct strbuf path = STRBUF_INIT;
2484+
static unsigned initialized;
2485+
2486+
if (!initialized) {
2487+
const char *env = mingw_getenv("PROGRAMDATA");
2488+
const char *extra = "";
2489+
if (!env) {
2490+
env = mingw_getenv("ALLUSERSPROFILE");
2491+
extra = "/Application Data";
2492+
}
2493+
if (env)
2494+
strbuf_addf(&path, "%s%s/Git/config", env, extra);
2495+
initialized = 1;
2496+
}
2497+
return *path.buf ? path.buf : NULL;
2498+
}

compat/mingw.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -427,6 +427,8 @@ static inline void convert_slashes(char *path)
427427
int mingw_offset_1st_component(const char *path);
428428
#define offset_1st_component mingw_offset_1st_component
429429
#define PATH_SEP ';'
430+
extern const char *program_data_config(void);
431+
#define git_program_data_config program_data_config
430432
#if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
431433
#define PRIuMAX "I64u"
432434
#define PRId64 "I64d"

config.c

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1221,9 +1221,12 @@ static int do_git_config_sequence(config_fn_t fn, void *data)
12211221
char *user_config = expand_user_path("~/.gitconfig");
12221222
char *repo_config = git_pathdup("config");
12231223

1224-
if (git_config_system())
1224+
if (git_config_system()) {
1225+
config_from_file_gently(fn, git_program_data_config(), data,
1226+
0, &ret, &found);
12251227
config_from_file_gently(fn, git_etc_gitconfig(), data, 0,
12261228
&ret, &found);
1229+
}
12271230

12281231
config_from_file_gently(fn, xdg_config, data, ACCESS_EACCES_OK,
12291232
&ret, &found);

git-compat-util.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -372,6 +372,10 @@ static inline char *git_find_last_dir_sep(const char *path)
372372
#define find_last_dir_sep git_find_last_dir_sep
373373
#endif
374374

375+
#ifndef git_program_data_config
376+
#define git_program_data_config() NULL
377+
#endif
378+
375379
#if defined(__HP_cc) && (__HP_cc >= 61000)
376380
#define NORETURN __attribute__((noreturn))
377381
#define NORETURN_PTR

0 commit comments

Comments
 (0)