undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

api-credential.txt: document that helpers field is filled-in automatically

Browse Source 
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>
This commit is contained in:
Matthieu Moy 2012-06-11 19:51:47 +02:00 committed by Junio C Hamano
parent fe77b416c7
commit 317d74be69
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Documentation/technical/api-credentials.txt
View File

@ -65,7 +65,10 @@ Data Structures
The `helpers` member of the struct is a `string_list` of helpers. Each 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 string specifies an external helper which will be run, in order, to
either acquire or store credentials. See the section on credential 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 This struct should always be initialized with `CREDENTIAL_INIT` or
`credential_init`. `credential_init`.