Skip to content

Commit 4f88b8a

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 a496171 + d0cc243 commit 4f88b8a

File tree

7 files changed

+64
-12
lines changed

7 files changed

+64
-12
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
@@ -1007,7 +1007,8 @@ for further details.
10071007

10081008
`GIT_CONFIG_NOSYSTEM`::
10091009
Whether to skip reading settings from the system-wide
1010-
`$(prefix)/etc/gitconfig` file. This environment variable can
1010+
`$(prefix)/etc/gitconfig` file (and on Windows, also from the
1011+
`%PROGRAMDATA%\Git\config` file). This environment variable can
10111012
be used along with `$HOME` and `$XDG_CONFIG_HOME` to create a
10121013
predictable environment for a picky script, or you can set it
10131014
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
@@ -2751,3 +2751,22 @@ int uname(struct utsname *buf)
27512751
"%u", (v >> 16) & 0x7fff);
27522752
return 0;
27532753
}
2754+
2755+
const char *program_data_config(void)
2756+
{
2757+
static struct strbuf path = STRBUF_INIT;
2758+
static unsigned initialized;
2759+
2760+
if (!initialized) {
2761+
const char *env = mingw_getenv("PROGRAMDATA");
2762+
const char *extra = "";
2763+
if (!env) {
2764+
env = mingw_getenv("ALLUSERSPROFILE");
2765+
extra = "/Application Data";
2766+
}
2767+
if (env)
2768+
strbuf_addf(&path, "%s%s/Git/config", env, extra);
2769+
initialized = 1;
2770+
}
2771+
return *path.buf ? path.buf : NULL;
2772+
}

compat/mingw.h

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

config.c

Lines changed: 26 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1249,9 +1249,15 @@ static int do_git_config_sequence(config_fn_t fn, void *data)
12491249
char *repo_config = git_pathdup("config");
12501250

12511251
current_parsing_scope = CONFIG_SCOPE_SYSTEM;
1252-
if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0))
1253-
ret += git_config_from_file(fn, git_etc_gitconfig(),
1254-
data);
1252+
if (git_config_system()) {
1253+
if (!access_or_die(git_program_data_config(), R_OK, 0))
1254+
ret += git_config_from_file(fn,
1255+
git_program_data_config(),
1256+
data);
1257+
if (!access_or_die(git_etc_gitconfig(), R_OK, 0))
1258+
ret += git_config_from_file(fn, git_etc_gitconfig(),
1259+
data);
1260+
}
12551261

12561262
current_parsing_scope = CONFIG_SCOPE_GLOBAL;
12571263
if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK))
@@ -2006,6 +2012,20 @@ int git_config_key_is_valid(const char *key)
20062012
return !git_config_parse_key_1(key, NULL, NULL, 1);
20072013
}
20082014

2015+
static int lock_config_file(const char *config_filename,
2016+
struct lock_file **result)
2017+
{
2018+
int fd;
2019+
2020+
*result = xcalloc(1, sizeof(struct lock_file));
2021+
fd = hold_lock_file_for_update(*result, config_filename, 0);
2022+
if (fd < 0)
2023+
error("could not lock config file %s: %s", config_filename,
2024+
strerror(errno));
2025+
2026+
return fd;
2027+
}
2028+
20092029
/*
20102030
* If value==NULL, unset in (remove from) config,
20112031
* if value_regex!=NULL, disregard key/value pairs where value does not match.
@@ -2057,8 +2077,7 @@ int git_config_set_multivar_in_file_gently(const char *config_filename,
20572077
* The lock serves a purpose in addition to locking: the new
20582078
* contents of .git/config will be written into it.
20592079
*/
2060-
lock = xcalloc(1, sizeof(struct lock_file));
2061-
fd = hold_lock_file_for_update(lock, config_filename, 0);
2080+
fd = lock_config_file(config_filename, &lock);
20622081
if (fd < 0) {
20632082
error_errno("could not lock config file %s", config_filename);
20642083
free(store.key);
@@ -2359,12 +2378,9 @@ int git_config_rename_section_in_file(const char *config_filename,
23592378
if (!config_filename)
23602379
config_filename = filename_buf = git_pathdup("config");
23612380

2362-
lock = xcalloc(1, sizeof(struct lock_file));
2363-
out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2364-
if (out_fd < 0) {
2365-
ret = error("could not lock config file %s", config_filename);
2381+
out_fd = lock_config_file(config_filename, &lock);
2382+
if (out_fd < 0)
23662383
goto out;
2367-
}
23682384

23692385
if (!(config_file = fopen(config_filename, "rb"))) {
23702386
/* 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)