aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2012-06-12 08:40:16 -0700
committerJunio C Hamano <gitster@pobox.com>2012-06-12 08:40:16 -0700
commit73a6e3c7947a120b46caa99fb9df000a8ac55c01 (patch)
tree73f648ecc07603f99fc60492f93fb63817c4abfd
parentd844808bb2d3c8df0eba23ec1950bc9cf2727452 (diff)
parent317d74be690f68748e8af9844407db3b100d836f (diff)
downloadgit-73a6e3c7947a120b46caa99fb9df000a8ac55c01.tar.gz
git-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.txt5
1 files changed, 4 insertions, 1 deletions
diff --git a/Documentation/technical/api-credentials.txt b/Documentation/technical/api-credentials.txt
index 4ef1db39a..adb6f0c89 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`.