Skip to content

Commit 453842c

Browse files
Knut Frankegitster
authored andcommitted
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>
1 parent 90e87b0 commit 453842c

2 files changed

Lines changed: 12 additions & 2 deletions

File tree

Documentation/config.txt

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,8 +453,11 @@ core.excludesfile::
453453
core.askpass::
454454
Some commands (e.g. svn and http interfaces) that interactively
455455
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.
458461

459462
core.editor::
460463
Commands such as `commit` and `tag` that lets you edit

Documentation/git.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -634,6 +634,13 @@ Usually it is easier to configure any desired options through your
634634
personal `.ssh/config` file. Please consult your ssh documentation
635635
for further details.
636636

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+
637644
'GIT_FLUSH'::
638645
If this environment variable is set to "1", then commands such
639646
as 'git blame' (in incremental mode), 'git rev-list', 'git log',

0 commit comments

Comments
 (0)