Skip to content

Commit

Permalink
api-credential.txt: document that helpers field is filled-in automati…
Browse files Browse the repository at this point in the history
…cally

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>
  • Loading branch information
Matthieu Moy authored and Junio C Hamano committed Jun 12, 2012
1 parent fe77b41 commit 317d74b
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion Documentation/technical/api-credentials.txt
Original file line number Diff line number Diff line change
@@ -65,7 +65,10 @@ Data Structures
The `helpers` member of the struct is a `string_list` of helpers. Each
string specifies an external helper which will be run, in order, to
either acquire or store credentials. See the section on credential
helpers below.
helpers below. This list is filled-in by the API functions
according to the corresponding configuration variables before
consulting helpers, so there usually is no need for a caller to
modify the helpers field at all.
+
This struct should always be initialized with `CREDENTIAL_INIT` or
`credential_init`.

0 comments on commit 317d74b

Please sign in to comment.