Skip to content

Commit 2e4ba82

Browse files
committed
Merge branch 'program-data-config'
This branch introduces support for reading the "Windows-wide" Git configuration from `%PROGRAMDATA%\Git\config`. As these settings are intended to be shared between *all* Git-related software, that config file takes an even lower precedence than `$(prefix)/etc/gitconfig`. Signed-off-by: Johannes Schindelin <[email protected]>
2 parents 9e657da + 3bf48fa commit 2e4ba82

File tree

7 files changed

+74
-27
lines changed

7 files changed

+74
-27
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: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,14 @@ $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 (located at `$PROGRAMDATA/Git/config`), intended to contain
258+
settings for *all* Git-related software running on the machine. Consequently,
259+
this config file takes an even lower precedence than the
260+
`$(prefix)/etc/gitconfig` file. Typically `$PROGRAMDATA` points to
261+
`C:\ProgramData` (on Windows XP the equivalent in `$ALLUSERSPROFILE` is used,
262+
i.e. `C:\Documents and Settings\All Users\Application Data\Git\config`).
263+
256264
If no further options are given, all reading options will read all of these
257265
files that are available. If the global or the system-wide configuration
258266
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
@@ -999,7 +999,8 @@ for further details.
999999

10001000
'GIT_CONFIG_NOSYSTEM'::
10011001
Whether to skip reading settings from the system-wide
1002-
`$(prefix)/etc/gitconfig` file. This environment variable can
1002+
`$(prefix)/etc/gitconfig` file (and on Windows, also from the
1003+
`%PROGRAMDATA%\Git\config` file). This environment variable can
10031004
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
10041005
predictable environment for a picky script, or you can set it
10051006
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
@@ -2732,3 +2732,22 @@ int uname(struct utsname *buf)
27322732
"%u", (v >> 16) & 0x7fff);
27332733
return 0;
27342734
}
2735+
2736+
const char *program_data_config(void)
2737+
{
2738+
static struct strbuf path = STRBUF_INIT;
2739+
static unsigned initialized;
2740+
2741+
if (!initialized) {
2742+
const char *env = mingw_getenv("PROGRAMDATA");
2743+
const char *extra = "";
2744+
if (!env) {
2745+
env = mingw_getenv("ALLUSERSPROFILE");
2746+
extra = "/Application Data";
2747+
}
2748+
if (env)
2749+
strbuf_addf(&path, "%s%s/Git/config", env, extra);
2750+
initialized = 1;
2751+
}
2752+
return *path.buf ? path.buf : NULL;
2753+
}

compat/mingw.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -425,6 +425,8 @@ static inline void convert_slashes(char *path)
425425
int mingw_offset_1st_component(const char *path);
426426
#define offset_1st_component mingw_offset_1st_component
427427
#define PATH_SEP ';'
428+
extern const char *program_data_config(void);
429+
#define git_program_data_config program_data_config
428430
#if !defined(__MINGW64_VERSION_MAJOR) && (!defined(_MSC_VER) || _MSC_VER < 1800)
429431
#define PRIuMAX "I64u"
430432
#define PRId64 "I64d"

config.c

Lines changed: 36 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1207,33 +1207,35 @@ int git_config_system(void)
12071207
return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
12081208
}
12091209

1210+
static inline void config_from_file_gently(config_fn_t fn, const char *filename,
1211+
void *data, unsigned access_flags, int *ret, int *found) {
1212+
if (!filename || access_or_die(filename, R_OK, access_flags))
1213+
return;
1214+
1215+
*ret += git_config_from_file(fn, filename, data);
1216+
(*found)++;
1217+
}
1218+
12101219
static int do_git_config_sequence(config_fn_t fn, void *data)
12111220
{
12121221
int ret = 0, found = 0;
12131222
char *xdg_config = xdg_config_home("config");
12141223
char *user_config = expand_user_path("~/.gitconfig");
12151224
char *repo_config = git_pathdup("config");
12161225

1217-
if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1218-
ret += git_config_from_file(fn, git_etc_gitconfig(),
1219-
data);
1220-
found += 1;
1226+
if (git_config_system()) {
1227+
config_from_file_gently(fn, git_program_data_config(), data,
1228+
0, &ret, &found);
1229+
config_from_file_gently(fn, git_etc_gitconfig(), data, 0,
1230+
&ret, &found);
12211231
}
12221232

1223-
if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1224-
ret += git_config_from_file(fn, xdg_config, data);
1225-
found += 1;
1226-
}
1227-
1228-
if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1229-
ret += git_config_from_file(fn, user_config, data);
1230-
found += 1;
1231-
}
1233+
config_from_file_gently(fn, xdg_config, data, ACCESS_EACCES_OK,
1234+
&ret, &found);
1235+
config_from_file_gently(fn, user_config, data, ACCESS_EACCES_OK,
1236+
&ret, &found);
12321237

1233-
if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1234-
ret += git_config_from_file(fn, repo_config, data);
1235-
found += 1;
1236-
}
1238+
config_from_file_gently(fn, repo_config, data, 0, &ret, &found);
12371239

12381240
switch (git_config_from_parameters(fn, data)) {
12391241
case -1: /* error */
@@ -1974,6 +1976,20 @@ int git_config_key_is_valid(const char *key)
19741976
return !git_config_parse_key_1(key, NULL, NULL, 1);
19751977
}
19761978

1979+
static int lock_config_file(const char *config_filename,
1980+
struct lock_file **result)
1981+
{
1982+
int fd;
1983+
1984+
*result = xcalloc(1, sizeof(struct lock_file));
1985+
fd = hold_lock_file_for_update(*result, config_filename, 0);
1986+
if (fd < 0)
1987+
error("could not lock config file %s: %s", config_filename,
1988+
strerror(errno));
1989+
1990+
return fd;
1991+
}
1992+
19771993
/*
19781994
* If value==NULL, unset in (remove from) config,
19791995
* if value_regex!=NULL, disregard key/value pairs where value does not match.
@@ -2025,10 +2041,8 @@ int git_config_set_multivar_in_file_gently(const char *config_filename,
20252041
* The lock serves a purpose in addition to locking: the new
20262042
* contents of .git/config will be written into it.
20272043
*/
2028-
lock = xcalloc(1, sizeof(struct lock_file));
2029-
fd = hold_lock_file_for_update(lock, config_filename, 0);
2044+
fd = lock_config_file(config_filename, &lock);
20302045
if (fd < 0) {
2031-
error("could not lock config file %s: %s", config_filename, strerror(errno));
20322046
free(store.key);
20332047
ret = CONFIG_NO_LOCK;
20342048
goto out_free;
@@ -2331,12 +2345,9 @@ int git_config_rename_section_in_file(const char *config_filename,
23312345
if (!config_filename)
23322346
config_filename = filename_buf = git_pathdup("config");
23332347

2334-
lock = xcalloc(1, sizeof(struct lock_file));
2335-
out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2336-
if (out_fd < 0) {
2337-
ret = error("could not lock config file %s", config_filename);
2348+
out_fd = lock_config_file(config_filename, &lock);
2349+
if (out_fd < 0)
23382350
goto out;
2339-
}
23402351

23412352
if (!(config_file = fopen(config_filename, "rb"))) {
23422353
/* no config file means nothing to rename, no error */

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)