]> git.ipfire.org Git - thirdparty/git.git/blobdiff - Documentation/gitcredentials.txt
gitcredentials(7): clarify quoting of helper examples
[thirdparty/git.git] / Documentation / gitcredentials.txt
index 1814d2d23c189c9597205eb2c0ca7f3d0c2306c3..8127dfcd2fbb5b42ad42c72a12d469059ee0e8d6 100644 (file)
@@ -216,20 +216,25 @@ 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]
+       helper = "!f() { echo \"password=$(cat $HOME/.secret)\"; }; f"
 ----------------------------------------------------
 
 Generally speaking, rule (3) above is the simplest for users to specify.