diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2012-06-12 08:40:16 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2012-06-12 08:40:16 -0700 |
| commit | 73a6e3c7947a120b46caa99fb9df000a8ac55c01 (patch) | |
| tree | 73f648ecc07603f99fc60492f93fb63817c4abfd | |
| parent | Merge branch 'jc/fmt-merge-msg-people' (diff) | |
| parent | api-credential.txt: document that helpers field is filled-in automatically (diff) | |
| download | tgif-73a6e3c7947a120b46caa99fb9df000a8ac55c01.tar.xz | |
Merge branch 'mm/api-credentials-doc'
* mm/api-credentials-doc:
api-credential.txt: document that helpers field is filled-in automatically
| -rw-r--r-- | Documentation/technical/api-credentials.txt | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/technical/api-credentials.txt b/Documentation/technical/api-credentials.txt index 4ef1db39ab..adb6f0c896 100644 --- a/Documentation/technical/api-credentials.txt +++ b/Documentation/technical/api-credentials.txt @@ -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`. |