Skip to content
This repository was archived by the owner on Nov 9, 2017. It is now read-only.

Commit 317d74b

Browse files
moygitster
authored andcommitted
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 <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent fe77b41 commit 317d74b

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

Documentation/technical/api-credentials.txt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,10 @@ Data Structures
6565
The `helpers` member of the struct is a `string_list` of helpers. Each
6666
string specifies an external helper which will be run, in order, to
6767
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.
6972
+
7073
This struct should always be initialized with `CREDENTIAL_INIT` or
7174
`credential_init`.

0 commit comments

Comments
 (0)