api-credential.txt: document that helpers field is filled-in automatically
It was unclear whether the field was to be specified by the user of the API. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Matthieu Moy committed
Jun 11, 2012 at 19:51 UTC
317d74be690f68748e8af9844407db3b100d836f
1 file changed
+4
-1
Documentation/technical/api-credentials.txt
+4
-1
@@ -65,7 +65,10 @@ Data Structures
65
The `helpers` member of the struct is a `string_list` of helpers. Each
66
string specifies an external helper which will be run, in order, to
67
either acquire or store credentials. See the section on credential
68
-helpers below.
68
+helpers below. This list is filled-in by the API functions
69
+according to the corresponding configuration variables before
70
+consulting helpers, so there usually is no need for a caller to
71
+modify the helpers field at all.
72
+
73
This struct should always be initialized with `CREDENTIAL_INIT` or
74
`credential_init`.