summaryrefslogtreecommitdiff
path: root/Documentation/technical/api-credentials.txt
diff options
context:
space:
mode:
authorMatthieu Moy <Matthieu.Moy@imag.fr>2012-06-11 17:51:47 (GMT)
committerJunio C Hamano <gitster@pobox.com>2012-06-12 14:48:40 (GMT)
commit317d74be690f68748e8af9844407db3b100d836f (patch)
tree92a85052f0054edb8fbc5cfa3a8bdc5a2e93ecb9 /Documentation/technical/api-credentials.txt
parentfe77b416c774a469a585c4b58fcae5e7a5f3545d (diff)
downloadgit-317d74be690f68748e8af9844407db3b100d836f.zip
git-317d74be690f68748e8af9844407db3b100d836f.tar.gz
git-317d74be690f68748e8af9844407db3b100d836f.tar.bz2
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/technical/api-credentials.txt')
-rw-r--r--Documentation/technical/api-credentials.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/technical/api-credentials.txt b/Documentation/technical/api-credentials.txt
index 4ef1db3..adb6f0c 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`.