threads / patch / 36249

v3Documentation/gitk: Document new config file location

Subject: [PATCH v3] Documentation/gitk: Document new config file location

## tl;dr

2 messages between Mar 20, 2014 and Mar 20, 2014. Diffs are folded; open one to read it.

replies: 1people: 2as markdown or json

Astril Hayato· Mar 20, 2014, 13:33 UTC · lore

User config file location now complies with the XDG base directory specification

Signed-off-by: Astril Hayato <astrilhayato@gmail.com>
---
 Documentation/gitk.txt | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

Show changes to Documentation/gitk.txt +8 −2

diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
index 1e9e38a..7e03fcc 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
 -------

-- 
1.9.0

Junio C Hamano· Mar 20, 2014, 18:01 UTC · re: Astril Hayato · lore

Re: [PATCH v3] Documentation/gitk: Document new config file location

Astril Hayato <astrilhayato@gmail.com> writes:

Show 25 quoted lines

> User config file location now complies with the XDG base directory specification
>
> Signed-off-by: Astril Hayato <astrilhayato@gmail.com>
> ---
>  Documentation/gitk.txt | 10 ++++++++--
>  1 file changed, 8 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt
> index 1e9e38a..7e03fcc 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.

Thanks; looks good.