path: root/Documentation
diff options
authorJunio C Hamano <>2015-05-11 21:23:38 (GMT)
committerJunio C Hamano <>2015-05-11 21:23:38 (GMT)
commit17c7f4d8e4e0e54148f77db4cf73e07aae484ae9 (patch)
tree36c80c734d15a0d9552945df17a52380cef9061b /Documentation
parent8440f74997cf7958c7e8ec853f590828085049b8 (diff)
parentefee5981d3d5d72f9cc7208ba7c5e9ce4afc8598 (diff)
Merge branch 'pt/credential-xdg'
Tweak the sample "store" backend of the credential helper to honor XDG configuration file locations when specified. * pt/credential-xdg: t0302: "unreadable" test needs POSIXPERM t0302: test credential-store support for XDG_CONFIG_HOME git-credential-store: support XDG_CONFIG_HOME git-credential-store: support multiple credential files
Diffstat (limited to 'Documentation')
1 files changed, 33 insertions, 2 deletions
diff --git a/Documentation/git-credential-store.txt b/Documentation/git-credential-store.txt
index bc97071..e3c8f27 100644
--- a/Documentation/git-credential-store.txt
+++ b/Documentation/git-credential-store.txt
@@ -31,10 +31,41 @@ OPTIONS
- Use `<path>` to store credentials. The file will have its
+ Use `<path>` to lookup and store credentials. The file will have its
filesystem permissions set to prevent other users on the system
from reading it, but will not be encrypted or otherwise
- protected. Defaults to `~/.git-credentials`.
+ protected. If not specified, credentials will be searched for from
+ `~/.git-credentials` and `$XDG_CONFIG_HOME/git/credentials`, and
+ credentials will be written to `~/.git-credentials` if it exists, or
+ `$XDG_CONFIG_HOME/git/credentials` if it exists and the former does
+ not. See also <<FILES>>.
+If not set explicitly with '--file', there are two files where
+git-credential-store will search for credentials in order of precedence:
+ User-specific credentials file.
+ Second user-specific credentials file. If '$XDG_CONFIG_HOME' is not set
+ or empty, `$HOME/.config/git/credentials` will be used. Any credentials
+ stored in this file will not be used if `~/.git-credentials` has a
+ matching credential as well. It is a good idea not to create this file
+ if you sometimes use older versions of Git that do not support it.
+For credential lookups, the files are read in the order given above, with the
+first matching credential found taking precedence over credentials found in
+files further down the list.
+Credential storage will by default write to the first existing file in the
+list. If none of these files exist, `~/.git-credentials` will be created and
+written to.
+When erasing credentials, matching credentials will be erased from all files.