git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCHv2] Possibility to read both from ~/.gitconfig and from $XDG_CONFIG_HOME/git/config

From
HNHuynh Khoi Nguyen NGUYEN <huynh-khoi-nguyen.nguyen@ensimag.imag.fr>
Date
May 30, 2012, 21:19 UTC
Message-ID
<1338412775-22840-1-git-send-email-Huynh-Khoi-Nguyen.Nguyen@ensimag.imag.fr>
In-Reply-To
<1338400509-26087-1-git-send-email-Huynh-Khoi-Nguyen.Nguyen@ensimag.imag.fr>
From: NGUYEN Huynh Khoi Nguyen <nguyenhu@ensibm.imag.fr>

Git will read both in $XDG_CONFIG_HOME/git/config and in ~/.gitconfig in this order: .git/config > ~/.gitconfig > $XDG_CONFIG_HOME/git/config > /etc/gitconfig If $XDG_CONFIG_HOME is either not set or empty, $HOME/.config/git/config will be used.

Signed-off-by: Huynh Khoi Nguyen NGUYEN <Huynh-Khoi-Nguyen.Nguyen@ensimag.imag.fr>
Signed-off-by: Lucien KONG <Lucien.Kong@ensimag.imag.fr>
Signed-off-by: Valentin DUPERRAY <Valentin.Duperray@ensimag.imag.fr>
Signed-off-by: Thomas NGUY <Thomas.Nguy@ensimag.imag.fr>
Signed-off-by: Franck JONAS <Franck.Jonas@ensimag.imag.fr>
---
 Documentation/git-config.txt    |    9 +++-
 builtin/config.c                |   48 +++++++++++++++++----
 config.c                        |   21 ++++++++--
 t/t1306-read-xdg-config-file.sh |   87 +++++++++++++++++++++++++++++++++++++++
 4 files changed, 149 insertions(+), 16 deletions(-)
 create mode 100755 t/t1306-read-xdg-config-file.sh
diff --git a/Documentation/git-config.txt b/Documentation/git-config.txt
index d9463cb..30418fa 100644
--- a/Documentation/git-config.txt
+++ b/Documentation/git-config.txt
@@ -99,8 +99,8 @@ OPTIONS
 	For writing options: write to global ~/.gitconfig file rather than
 	the repository .git/config.
 +
-For reading options: read only from global ~/.gitconfig rather than
-from all available files.
+For reading options: read only from global ~/.gitconfig then from
+$XDG_CONFIG_HOME/git/config rather than from all available files.
 +
 See also <<FILES>>.
 
@@ -194,7 +194,7 @@ See also <<FILES>>.
 FILES
 -----
 
-If not set explicitly with '--file', there are three files where
+If not set explicitly with '--file', there are four files where
 'git config' will search for configuration options:
 
 $GIT_DIR/config::
@@ -204,6 +204,9 @@ $GIT_DIR/config::
 	User-specific configuration file. Also called "global"
 	configuration file.
 
+$XDG_CONFIG_HOME/git/config::
+	Second user-specific configuration file. ~/.gitconfig has priority.
+
 $(prefix)/etc/gitconfig::
 	System-wide configuration file.
 
diff --git a/builtin/config.c b/builtin/config.c
index 33c8820..38dba4f 100644
--- a/builtin/config.c
+++ b/builtin/config.c
@@ -161,7 +161,7 @@ static int show_config(const char *key_, const char *value_, void *cb)
 static int get_value(const char *key_, const char *regex_)
 {
 	int ret = -1;
-	char *global = NULL, *repo_config = NULL;
+	char *gitconfig_global = NULL, *xdg_global = NULL, *repo_config = NULL;
 	const char *system_wide = NULL, *local;
 	struct config_include_data inc = CONFIG_INCLUDE_INIT;
 	config_fn_t fn;
@@ -171,8 +171,15 @@ static int get_value(const char *key_, const char *regex_)
 	if (!local) {
 		const char *home = getenv("HOME");
 		local = repo_config = git_pathdup("config");
-		if (home)
-			global = xstrdup(mkpath("%s/.gitconfig", home));
+		if (home) {
+			const char *xdg_config_home = getenv("XDG_CONFIG_HOME");
+			if (xdg_config_home)
+				xdg_global = xstrdup(mkpath("%s/git/config", xdg_config_home));
+			else
+				xdg_global = xstrdup(mkpath("%s/.config/git/config", home));
+
+			gitconfig_global = xstrdup(mkpath("%s/.gitconfig", home));
+		}
 		if (git_config_system())
 			system_wide = git_etc_gitconfig();
 	}
@@ -229,15 +236,19 @@ static int get_value(const char *key_, const char *regex_)
 
 	if (do_all && system_wide)
 		git_config_from_file(fn, system_wide, data);
-	if (do_all && global)
-		git_config_from_file(fn, global, data);
+	if (do_all && xdg_global)
+		git_config_from_file(fn, xdg_global, data);
+	if (do_all && gitconfig_global)
+		git_config_from_file(fn, gitconfig_global, data);
 	if (do_all)
 		git_config_from_file(fn, local, data);
 	git_config_from_parameters(fn, data);
 	if (!do_all && !seen)
 		git_config_from_file(fn, local, data);
-	if (!do_all && !seen && global)
-		git_config_from_file(fn, global, data);
+	if (!do_all && !seen && gitconfig_global)
+		git_config_from_file(fn, gitconfig_global, data);
+	if (!do_all && !seen && xdg_global)
+		git_config_from_file(fn, xdg_global, data);
 	if (!do_all && !seen && system_wide)
 		git_config_from_file(fn, system_wide, data);
 
@@ -254,7 +265,8 @@ static int get_value(const char *key_, const char *regex_)
 
 free_strings:
 	free(repo_config);
-	free(global);
+	free(gitconfig_global);
+	free(xdg_global);
 	return ret;
 }
 
@@ -381,7 +393,25 @@ int cmd_config(int argc, const char **argv, const char *prefix)
 	if (use_global_config) {
 		char *home = getenv("HOME");
 		if (home) {
-			char *user_config = xstrdup(mkpath("%s/.gitconfig", home));
+			char *user_config;
+			const char *gitconfig_path = mkpath("%s/.gitconfig", home);
+			const char *xdg_config_path = NULL;
+			const char *xdg_config_home = NULL;
+
+			xdg_config_home = getenv("XDG_CONFIG_HOME");
+			if (xdg_config_home)
+				xdg_config_path = mkpath("%s/git/config", xdg_config_home);
+			else
+				xdg_config_path = mkpath("%s/.config/git/config", home);
+
+			if (access(gitconfig_path, R_OK) && !access(xdg_config_path, R_OK) &&
+			    (actions == ACTION_LIST ||
+			     actions == ACTION_GET_COLOR ||
+			     actions == ACTION_GET_COLORBOOL))
+				user_config = xstrdup(xdg_config_path);
+			else
+				user_config = xstrdup(gitconfig_path);
+
 			given_config_file = user_config;
 		} else {
 			die("$HOME not set");
diff --git a/config.c b/config.c
index 71ef171..53557dc 100644
--- a/config.c
+++ b/config.c
@@ -939,10 +939,23 @@ int git_config_early(config_fn_t fn, void *data, const char *repo_config)
 
 	home = getenv("HOME");
 	if (home) {
-		char buf[PATH_MAX];
-		char *user_config = mksnpath(buf, sizeof(buf), "%s/.gitconfig", home);
-		if (!access(user_config, R_OK)) {
-			ret += git_config_from_file(fn, user_config, data);
+		const char *gitconfig_path = xstrdup(mkpath("%s/.gitconfig", home));
+		const char *xdg_config_path = NULL;
+		const char *xdg_config_home = NULL;
+
+		xdg_config_home = getenv("XDG_CONFIG_HOME");
+		if (xdg_config_home)
+			xdg_config_path = xstrdup(mkpath("%s/git/config", xdg_config_home));
+		else
+			xdg_config_path = xstrdup(mkpath("%s/.config/git/config", home));
+
+		if (!access(xdg_config_path, R_OK)) {
+			ret += git_config_from_file(fn, xdg_config_path, data);
+			found += 1;
+		}
+
+		if (!access(gitconfig_path, R_OK)) {
+			ret += git_config_from_file(fn, gitconfig_path, data);
 			found += 1;
 		}
 	}
diff --git a/t/t1306-read-xdg-config-file.sh b/t/t1306-read-xdg-config-file.sh
new file mode 100755
index 0000000..4cab38b
--- /dev/null
+++ b/t/t1306-read-xdg-config-file.sh
@@ -0,0 +1,87 @@
+#!/bin/sh
+#
+# Copyright (c) 2012 Valentin Duperray, Lucien Kong, Franck Jonas,
+#		     Thomas Nguy, Khoi Nguyen
+#		     Grenoble INP Ensimag
+#
+
+test_description='possibility to read $XDG_CONFIG_HOME/git/config file'
+
+. ./test-lib.sh
+
+test_expect_success 'read automatically: xdg file exists and ~/.gitconfig doesn'\''t' '
+	mkdir -p .config/git &&
+	echo "[advice]" >.config/git/config &&
+	echo "	statushints = false" >>.config/git/config &&
+	cat >expect <<-\EOF &&
+	# On branch master
+	#
+	# Initial commit
+	#
+	# Untracked files:
+	#	.config/
+	#	expect
+	#	output
+	nothing added to commit but untracked files present
+	EOF
+	git status >output &&
+	test_cmp expect output
+'
+
+test_expect_success 'read automatically: xdg file exists and ~/.gitconfig exists' '
+	>.gitconfig &&
+	echo "[advice]" >.gitconfig &&
+	echo "	statushints = true" >>.gitconfig &&
+	cat >expect <<-\EOF &&
+	# On branch master
+	#
+	# Initial commit
+	#
+	# Untracked files:
+	#   (use "git add <file>..." to include in what will be committed)
+	#
+	#	.config/
+	#	.gitconfig
+	#	expect
+	#	output
+	nothing added to commit but untracked files present (use "git add" to track)
+	EOF
+	git status >output &&
+	test_cmp expect output
+'
+
+test_expect_success 'read with --get: xdg file exists and ~/.gitconfig doesn'\''t' '
+	rm .gitconfig &&
+	echo "[user]" >.config/git/config &&
+	echo "	name = read_config" >>.config/git/config &&
+	echo read_config >expect &&
+	git config --get user.name >output &&
+	test_cmp expect output
+'
+
+test_expect_success 'read with --get: xdg file exists and ~/.gitconfig exists' '
+	>.gitconfig &&
+	echo "[user]" >.gitconfig &&
+	echo "	name = read_gitconfig" >>.gitconfig &&
+	echo read_gitconfig >expect &&
+	git config --get user.name >output &&
+	test_cmp expect output
+'
+
+test_expect_success 'read with --list: xdg file exists and ~/.gitconfig doesn'\''t' '
+	rm .gitconfig &&
+	echo user.name=read_config >expect &&
+	git config --global --list >output &&
+	test_cmp expect output
+'
+
+test_expect_success 'read with --list: xdg file exists and ~/.gitconfig exists' '
+	>.gitconfig &&
+	echo "[user]" >.gitconfig &&
+	echo "	name = read_gitconfig" >>.gitconfig &&
+	echo user.name=read_gitconfig >expect &&
+	git config --global --list >output &&
+	test_cmp expect output
+'
+
+test_done

-- 
1.7.8
Next: Junio C Hamano
Message 1 of 88 in “[PATCHv2] Possibility to read both from ~/.gitconfig and from $XDG_CONFIG_HOME/git/config”
  1. Huynh Khoi Nguyen NGUYENMay 30, 2012
  2. Junio C HamanoMay 30, 2012
  3. Ramsay JonesMay 31, 2012
  4. [PATCHv3] Read from XDG configuration file, not writeHuynh Khoi Nguyen NGUYEN, May 31, 2012
  5. Junio C HamanoMay 31, 2012
  6. [PATCHv4] Read (but not write) from XDG configuration, XDG attributes and XDG ignore filesHuynh Khoi Nguyen NGUYEN, Jun 1, 2012
  7. Matthieu MoyJun 2, 2012
  8. nguyenhu@minatec.inpg.frJun 2, 2012
  9. Matthieu MoyJun 2, 2012
  10. 1/4 Read (but not write) from $XDG_CONFIG_HOME/git/config fileHuynh Khoi Nguyen NGUYEN, Jun 3, 2012
  11. 2/4 Let core.excludesfile default to $XDG_CONFIG_HOME/git/ignoreHuynh Khoi Nguyen NGUYEN, Jun 3, 2012
  12. Matthieu MoyJun 4, 2012
  13. nguyenhu@minatec.inpg.frJun 5, 2012
  14. 3/4 Let core.attributesfile default to $XDG_CONFIG_HOME/git/attributesHuynh Khoi Nguyen NGUYEN, Jun 3, 2012
  15. 4/4 Write to $XDG_CONFIG_HOME/git/config fileHuynh Khoi Nguyen NGUYEN, Jun 3, 2012
  16. Matthieu MoyJun 4, 2012
  17. nguyenhu@minatec.inpg.frJun 5, 2012
  18. 1/4 Read (but not write) from $XDG_CONFIG_HOME/git/config fileHuynh Khoi Nguyen NGUYEN, Jun 6, 2012
  19. 2/4 Let core.excludesfile default to $XDG_CONFIG_HOME/git/ignoreHuynh Khoi Nguyen NGUYEN, Jun 6, 2012
  20. Junio C HamanoJun 7, 2012
  21. Matthieu MoyJun 8, 2012
  22. nguyenhu@minatec.inpg.frJun 8, 2012
  23. 3/4 Let core.attributesfile default to $XDG_CONFIG_HOME/git/attributesHuynh Khoi Nguyen NGUYEN, Jun 6, 2012
  24. 4/4 Write to $XDG_CONFIG_HOME/git/config fileHuynh Khoi Nguyen NGUYEN, Jun 6, 2012
  25. David AguilarJun 9, 2012
  26. Junio C HamanoJun 9, 2012
  27. David AguilarJun 9, 2012
  28. Matthieu MoyJun 10, 2012
  29. nguyenhu@minatec.inpg.frJun 11, 2012
  30. Junio C HamanoJun 7, 2012
  31. nguyenhu@minatec.inpg.frJun 8, 2012
  32. Ramsay JonesJun 12, 2012
  33. nguyenhu@minatec.inpg.frJun 8, 2012
  34. Erik Faye-LundJun 8, 2012
  35. nguyenhu@minatec.inpg.frJun 8, 2012
  36. Erik Faye-LundJun 8, 2012
  37. Junio C HamanoJun 8, 2012
  38. nguyenhu@minatec.inpg.frJun 9, 2012
  39. Junio C HamanoJun 10, 2012
  40. nguyenhu@minatec.inpg.frJun 10, 2012
  41. Erik Faye-LundJun 10, 2012
  42. nguyenhu@minatec.inpg.frJun 10, 2012
  43. Erik Faye-LundJun 10, 2012
  44. Junio C HamanoJun 11, 2012
  45. nguyenhu@minatec.inpg.frJun 11, 2012
  46. nguyenhu@minatec.inpg.frJun 11, 2012
  47. Erik Faye-LundJun 11, 2012
  48. 1/4 Read (but not write) from $XDG_CONFIG_HOME/git/config fileHuynh Khoi Nguyen Nguyen, Jun 12, 2012
  49. 2/4 Let core.excludesfile default to $XDG_CONFIG_HOME/git/ignoreHuynh Khoi Nguyen Nguyen, Jun 12, 2012
  50. 3/4 Let core.attributesfile default to $XDG_CONFIG_HOME/git/attributesHuynh Khoi Nguyen Nguyen, Jun 12, 2012
  51. 4/4 Write to $XDG_CONFIG_HOME/git/config fileHuynh Khoi Nguyen Nguyen, Jun 12, 2012
  52. Ramsay JonesJun 14, 2012
  53. Matthieu MoyJun 21, 2012
  54. Junio C HamanoJun 21, 2012
  55. 0/4 Git configuration directoryMatthieu Moy, Jun 22, 2012
  56. 1/4 config: read (but not write) from $XDG_CONFIG_HOME/git/config fileMatthieu Moy, Jun 22, 2012
  57. Thomas RastJul 12, 2012
  58. config: fix several access(NULL) callsMatthieu Moy, Jul 12, 2012
  59. Thomas RastJul 12, 2012
  60. Junio C HamanoJul 12, 2012
  61. Matthieu MoyJul 12, 2012
  62. Junio C HamanoJul 12, 2012
  63. Matthieu MoyJul 13, 2012
  64. config: fix several access(NULL) callsMatthieu Moy, Jul 13, 2012
  65. Jeff KingJul 13, 2012
  66. Matthieu MoyJul 13, 2012
  67. Thomas RastJul 13, 2012
  68. Matthieu MoyJul 13, 2012
  69. Junio C HamanoJul 13, 2012
  70. Matthieu MoyJul 16, 2012
  71. Junio C HamanoJul 16, 2012
  72. Matthieu MoyJul 16, 2012
  73. Junio C HamanoJul 16, 2012
  74. 2/4 Let core.excludesfile default to $XDG_CONFIG_HOME/git/ignoreMatthieu Moy, Jun 22, 2012
  75. 3/4 Let core.attributesfile default to $XDG_CONFIG_HOME/git/ignoreMatthieu Moy, Jun 22, 2012
  76. Junio C HamanoJun 22, 2012
  77. Matthieu MoyJun 25, 2012
  78. Junio C HamanoJun 25, 2012
  79. Matthieu MoyJun 25, 2012
  80. 4/4 config: write to $XDG_CONFIG_HOME/git/config file if appropriateMatthieu Moy, Jun 22, 2012
  81. Junio C HamanoJun 22, 2012
  82. Matthieu MoyJun 25, 2012
  83. Junio C HamanoJun 25, 2012
  84. Junio C HamanoJun 22, 2012
  85. Ramsay JonesJun 4, 2012
  86. Junio C HamanoJun 4, 2012
  87. Ramsay JonesJun 12, 2012
  88. nguyenhu@minatec.inpg.frJun 5, 2012

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.