diff options
| author |  Matthieu Moy <Matthieu.Moy@imag.fr> | 2012-06-11 19:51:47 +0200 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2012-06-12 07:48:40 -0700 |
| commit | 317d74be690f68748e8af9844407db3b100d836f (patch) | |
| tree | 92a85052f0054edb8fbc5cfa3a8bdc5a2e93ecb9 /Documentation | |
| parent | docs: fix cross-directory linkgit references (diff) | |
| download | tgif-317d74be690f68748e8af9844407db3b100d836f.tar.xz | |
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>
Diffstat (limited to 'Documentation')
| -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`. |