Skip to content

Commit 49806da

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 84af156 + 411cfc0 commit 49806da

File tree

7 files changed

+78
-27
lines changed

7 files changed

+78
-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
@@ -246,6 +246,14 @@ $XDG_CONFIG_HOME/git/config::
246246
$GIT_DIR/config::
247247
Repository specific configuration file.
248248

249+
On Windows, as there is no central `/etc/` directory, there is yet another
250+
config file (located at `$PROGRAMDATA/Git/config`), intended to contain
251+
settings for *all* Git-related software running on the machine. Consequently,
252+
this config file takes an even lower precedence than the
253+
`$(prefix)/etc/gitconfig` file. Typically `$PROGRAMDATA` points to
254+
`C:\ProgramData` (on Windows XP the equivalent in `$ALLUSERSPROFILE` is used,
255+
i.e. `C:\Documents and Settings\All Users\Application Data\Git\config`).
256+
249257
If no further options are given, all reading options will read all of these
250258
files that are available. If the global or the system-wide configuration
251259
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
@@ -987,7 +987,8 @@ for further details.
987987

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

compat/mingw.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -418,6 +418,8 @@ static inline char *mingw_find_last_dir_sep(const char *path)
418418
int mingw_offset_1st_component(const char *path);
419419
#define offset_1st_component mingw_offset_1st_component
420420
#define PATH_SEP ';'
421+
extern const char *program_data_config(void);
422+
#define git_program_data_config program_data_config
421423
#ifndef __MINGW64_VERSION_MAJOR
422424
#define PRIuMAX "I64u"
423425
#define PRId64 "I64d"

config.c

Lines changed: 40 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1203,32 +1203,34 @@ int git_config_system(void)
12031203
return !git_env_bool("GIT_CONFIG_NOSYSTEM", 0);
12041204
}
12051205

1206+
static inline void config_from_file_gently(config_fn_t fn, const char *filename,
1207+
void *data, unsigned access_flags, int *ret, int *found) {
1208+
if (!filename || access_or_die(filename, R_OK, access_flags))
1209+
return;
1210+
1211+
*ret += git_config_from_file(fn, filename, data);
1212+
(*found)++;
1213+
}
1214+
12061215
int git_config_early(config_fn_t fn, void *data, const char *repo_config)
12071216
{
12081217
int ret = 0, found = 0;
12091218
char *xdg_config = xdg_config_home("config");
12101219
char *user_config = expand_user_path("~/.gitconfig");
12111220

1212-
if (git_config_system() && !access_or_die(git_etc_gitconfig(), R_OK, 0)) {
1213-
ret += git_config_from_file(fn, git_etc_gitconfig(),
1214-
data);
1215-
found += 1;
1221+
if (git_config_system()) {
1222+
config_from_file_gently(fn, git_program_data_config(), data,
1223+
0, &ret, &found);
1224+
config_from_file_gently(fn, git_etc_gitconfig(), data, 0,
1225+
&ret, &found);
12161226
}
12171227

1218-
if (xdg_config && !access_or_die(xdg_config, R_OK, ACCESS_EACCES_OK)) {
1219-
ret += git_config_from_file(fn, xdg_config, data);
1220-
found += 1;
1221-
}
1222-
1223-
if (user_config && !access_or_die(user_config, R_OK, ACCESS_EACCES_OK)) {
1224-
ret += git_config_from_file(fn, user_config, data);
1225-
found += 1;
1226-
}
1228+
config_from_file_gently(fn, xdg_config, data, ACCESS_EACCES_OK,
1229+
&ret, &found);
1230+
config_from_file_gently(fn, user_config, data, ACCESS_EACCES_OK,
1231+
&ret, &found);
12271232

1228-
if (repo_config && !access_or_die(repo_config, R_OK, 0)) {
1229-
ret += git_config_from_file(fn, repo_config, data);
1230-
found += 1;
1231-
}
1233+
config_from_file_gently(fn, repo_config, data, 0, &ret, &found);
12321234

12331235
switch (git_config_from_parameters(fn, data)) {
12341236
case -1: /* error */
@@ -1944,6 +1946,24 @@ int git_config_key_is_valid(const char *key)
19441946
return !git_config_parse_key_1(key, NULL, NULL, 1);
19451947
}
19461948

1949+
static int lock_config_file(const char *config_filename,
1950+
struct lock_file **result)
1951+
{
1952+
int fd;
1953+
1954+
/* make sure the parent directory exists */
1955+
if (safe_create_leading_directories_const(config_filename))
1956+
return error("could not create parent directory of %s",
1957+
config_filename);
1958+
*result = xcalloc(1, sizeof(struct lock_file));
1959+
fd = hold_lock_file_for_update(*result, config_filename, 0);
1960+
if (fd < 0)
1961+
error("could not lock config file %s: %s", config_filename,
1962+
strerror(errno));
1963+
1964+
return fd;
1965+
}
1966+
19471967
/*
19481968
* If value==NULL, unset in (remove from) config,
19491969
* if value_regex!=NULL, disregard key/value pairs where value does not match.
@@ -1994,10 +2014,8 @@ int git_config_set_multivar_in_file(const char *config_filename,
19942014
* The lock serves a purpose in addition to locking: the new
19952015
* contents of .git/config will be written into it.
19962016
*/
1997-
lock = xcalloc(1, sizeof(struct lock_file));
1998-
fd = hold_lock_file_for_update(lock, config_filename, 0);
2017+
fd = lock_config_file(config_filename, &lock);
19992018
if (fd < 0) {
2000-
error("could not lock config file %s: %s", config_filename, strerror(errno));
20012019
free(store.key);
20022020
ret = CONFIG_NO_LOCK;
20032021
goto out_free;
@@ -2280,12 +2298,9 @@ int git_config_rename_section_in_file(const char *config_filename,
22802298
if (!config_filename)
22812299
config_filename = filename_buf = git_pathdup("config");
22822300

2283-
lock = xcalloc(1, sizeof(struct lock_file));
2284-
out_fd = hold_lock_file_for_update(lock, config_filename, 0);
2285-
if (out_fd < 0) {
2286-
ret = error("could not lock config file %s", config_filename);
2301+
out_fd = lock_config_file(config_filename, &lock);
2302+
if (out_fd < 0)
22872303
goto out;
2288-
}
22892304

22902305
if (!(config_file = fopen(config_filename, "rb"))) {
22912306
/* 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
@@ -371,6 +371,10 @@ static inline char *git_find_last_dir_sep(const char *path)
371371
#define find_last_dir_sep git_find_last_dir_sep
372372
#endif
373373

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

0 commit comments

Comments
 (0)