Skip to content

Commit 4919938

Browse files
mjcheethamgitster
authored andcommitted
doc: clarify http.emptyAuth values
The existing description of http.emptyAuth explains the purpose of the setting but never says what values it accepts. Readers have to infer from context (or read the source) that it takes 'true', 'false', or 'auto', and what each one means. Document the three accepted values explicitly: * 'auto' (the default) only sends empty credentials when the server's 401 response advertises a mechanism that requires them, such as GSS-Negotiate. This matches the long-standing auto-detection behaviour added in 40a18fc (http: add an "auto" mode for http.emptyauth, 2017-02-25). * 'true' unconditionally sends empty credentials on the very first request, before any 401 response, for callers that know they want this behaviour up front. * 'false' disables the feature entirely; mechanisms that depend on empty credentials, such as GSS-Negotiate, will not work in this mode. Signed-off-by: Matthew John Cheetham <mjcheetham@outlook.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
1 parent 9b1630b commit 4919938

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

Documentation/config/http.adoc

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,18 @@ http.emptyAuth::
5959
Attempt authentication without seeking a username or password. This
6060
can be used to attempt GSS-Negotiate authentication without specifying
6161
a username in the URL, as libcurl normally requires a username for
62-
authentication.
62+
authentication. Possible values are:
63+
+
64+
--
65+
* `auto` (default) - Send empty credentials only if the server's 401 response
66+
advertises an authentication mechanism that requires them (such as
67+
GSS-Negotiate); otherwise fall back to prompting via the credential helper.
68+
* `true` - Always send empty credentials on the very first request, before
69+
receiving any 401 response from the server.
70+
* `false` - Never send empty credentials. Mechanisms that require
71+
empty credentials or an explicit username, such as GSS-Negotiate, will not
72+
work.
73+
--
6374

6475
http.proactiveAuth::
6576
Attempt authentication without first making an unauthenticated attempt and

0 commit comments

Comments
 (0)