summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-05-08 21:25:02 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-05-08 21:25:03 (GMT)
commit1260f819aa757c184b2d7afd6f27ad48f625677b (patch)
tree1a985d2b97b637caa99f242a74d2c318f0d34c1a /Documentation
parentdc4c3933b189f7c3087008d3dc2b16ef8325ab1b (diff)
parent177681a07ea1c486b41db666b67c2fabd3c5a1d8 (diff)
downloadgit-1260f819aa757c184b2d7afd6f27ad48f625677b.zip
git-1260f819aa757c184b2d7afd6f27ad48f625677b.tar.gz
git-1260f819aa757c184b2d7afd6f27ad48f625677b.tar.bz2
Merge branch 'jk/credential-sample-update'
The samples in the credential documentation has been updated to make it clear that we depict what would appear in the .git/config file, by adding appropriate quotes as needed.. * jk/credential-sample-update: gitcredentials(7): make shell-snippet example more realistic gitcredentials(7): clarify quoting of helper examples
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/gitcredentials.txt16
1 files changed, 11 insertions, 5 deletions
diff --git a/Documentation/gitcredentials.txt b/Documentation/gitcredentials.txt
index 1814d2d..0d0f714 100644
--- a/Documentation/gitcredentials.txt
+++ b/Documentation/gitcredentials.txt
@@ -216,20 +216,26 @@ Here are some example specifications:
----------------------------------------------------
# run "git credential-foo"
-foo
+[credential]
+ helper = foo
# same as above, but pass an argument to the helper
-foo --bar=baz
+[credential]
+ helper = "foo --bar=baz"
# the arguments are parsed by the shell, so use shell
# quoting if necessary
-foo --bar="whitespace arg"
+[credential]
+ helper = "foo --bar='whitespace arg'"
# you can also use an absolute path, which will not use the git wrapper
-/path/to/my/helper --with-arguments
+[credential]
+ helper = "/path/to/my/helper --with-arguments"
# or you can specify your own shell snippet
-!f() { echo "password=`cat $HOME/.secret`"; }; f
+[credential "https://example.com"]
+ username = your_user
+ helper = "!f() { test \"$1\" = get && echo \"password=$(cat $HOME/.secret)\"; }; f"
----------------------------------------------------
Generally speaking, rule (3) above is the simplest for users to specify.