Extend documentation of core.askpass and GIT_ASKPASS.
Signed-off-by: Knut Franke <k.franke@science-computing.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Knut Franke committed
Aug 30, 2010 at 15:40 UTC
453842c9b81c6bb1328b0dfc351745615004a77f
2 files changed
+12
-2
Documentation/config.txt
+5
-2
@@ -453,8 +453,11 @@ core.excludesfile::
453
core.askpass::
454
Some commands (e.g. svn and http interfaces) that interactively
455
ask for a password can be told to use an external program given
456
- via the value of this variable when it is set, and the
457
- environment variable `GIT_ASKPASS` is not set.
456
+ via the value of this variable. Can be overridden by the 'GIT_ASKPASS'
457
+ environment variable. If not set, fall back to the value of the
458
+ 'SSH_ASKPASS' environment variable or, failing that, a simple password
459
+ prompt. The external program shall be given a suitable prompt as
460
+ command line argument and write the password on its STDOUT.
461
462
core.editor::
463
Commands such as `commit` and `tag` that lets you edit
Documentation/git.txt
+7
@@ -634,6 +634,13 @@ Usually it is easier to configure any desired options through your
634
personal `.ssh/config` file. Please consult your ssh documentation
635
for further details.
636
637
+'GIT_ASKPASS'::
638
+ If this environment variable is set, then git commands which need to
639
+ acquire passwords or passphrases (e.g. for HTTP or IMAP authentication)
640
+ will call this program with a suitable prompt as command line argument
641
+ and read the password from its STDOUT. See also the 'core.askpass'
642
+ option in linkgit:git-config[1].
643
+
644
'GIT_FLUSH'::
645
If this environment variable is set to "1", then commands such
646
as 'git blame' (in incremental mode), 'git rev-list', 'git log',