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
This commit is contained in:
Junio C Hamano 2020-05-08 14:25:02 -07:00
commit 1260f819aa

View File

@ -216,20 +216,26 @@ Here are some example specifications:
---------------------------------------------------- ----------------------------------------------------
# run "git credential-foo" # run "git credential-foo"
foo [credential]
helper = foo
# same as above, but pass an argument to the helper # 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 # the arguments are parsed by the shell, so use shell
# quoting if necessary # 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 # 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 # 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. Generally speaking, rule (3) above is the simplest for users to specify.