Documentation/gitk: document the location of the configulation file
User config file location complies with the XDG base directory specification while supporting the traditional $HOME/.gitk as a fallback. Signed-off-by: Astril Hayato <astrilhayato@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Astril Hayato committed
Mar 20, 2014 at 13:33 UTC
36dc827bc9d17f80ed4f326de21247a5d1341fbc
1 file changed
+8
-2
Documentation/gitk.txt
+8
-2
@@ -166,8 +166,14 @@ gitk --max-count=100 --all \-- Makefile::
166
167
Files
168
-----
169
-Gitk creates the .gitk file in your $HOME directory to store preferences
170
-such as display options, font, and colors.
169
+User configuration and preferences are stored at:
170
+
171
+* '$XDG_CONFIG_HOME/git/gitk' if it exists, otherwise
172
+* '$HOME/.gitk' if it exists
173
+
174
+If neither of the above exist then '$XDG_CONFIG_HOME/git/gitk' is created and
175
+used by default. If '$XDG_CONFIG_HOME' is not set it defaults to
176
+'$HOME/.config' in all cases.
177
178
History
179
-------