[PATCH] api-credential.txt: document that helpers field is filled-in automatically
From: Matthieu Moy <hidden>
Date: 2016-06-15 22:54:02
Subsystem:
documentation, the rest · Maintainers:
Jonathan Corbet, Linus Torvalds
It was unclear whether the field was to be specified by the user of the API. Signed-off-by: Matthieu Moy <redacted> --- A quick grep in Git's source code seems to show that no user of the API explicitely modify this "helpers" field (except test-credential.c). Documentation/technical/api-credentials.txt | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-)
diff --git a/Documentation/technical/api-credentials.txt b/Documentation/technical/api-credentials.txt
index 21ca6a2..fc6d2b9 100644
--- a/Documentation/technical/api-credentials.txt
+++ b/Documentation/technical/api-credentials.txt@@ -46,7 +46,9 @@ Functions consulting helpers, then asking the user. After this function returns, the username and password fields of the credential are guaranteed to be non-NULL. If an error occurs, the function will - die(). + die(). The `helpers` member of the structure is filled-in + according to the corresponding configuration variables before + consulting helpers. `credential_reject`::
--
1.7.11.rc0.57.g84a04c7