summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAstril Hayato <astrilhayato@gmail.com>2014-03-20 13:33:49 +0000
committerJunio C Hamano <gitster@pobox.com>2014-03-20 10:59:55 -0700
commit36dc827bc9d17f80ed4f326de21247a5d1341fbc (patch)
tree46db335464764669c6056c62663153b6d5148f41
parent5f95c9f850b19b368c43ae399cc831b17a26a5ac (diff)
downloadgit-ah/doc-gitk-config.tar.gz
Documentation/gitk: document the location of the configulation fileah/doc-gitk-config
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>
-rw-r--r--Documentation/gitk.txt10
1 files changed, 8 insertions, 2 deletions
diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index 1e9e38ae40..7e03fcc62d 100644
--- a/Documentation/gitk.txt
+++ b/Documentation/gitk.txt
@@ -166,8 +166,14 @@ gitk --max-count=100 --all \-- Makefile::
Files
-----
-Gitk creates the .gitk file in your $HOME directory to store preferences
-such as display options, font, and colors.
+User configuration and preferences are stored at:
+
+* '$XDG_CONFIG_HOME/git/gitk' if it exists, otherwise
+* '$HOME/.gitk' if it exists
+
+If neither of the above exist then '$XDG_CONFIG_HOME/git/gitk' is created and
+used by default. If '$XDG_CONFIG_HOME' is not set it defaults to
+'$HOME/.config' in all cases.
History
-------