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>
This commit is contained in:
Astril Hayato 2014-03-20 13:33:49 +00:00 committed by Junio C Hamano
parent 5f95c9f850
commit 36dc827bc9

View file

@ -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
-------