From: Matthieu Moy Date: Mon, 11 Jun 2012 17:51:47 GMT Subject: [PATCH] api-credential.txt: document that helpers field is filled-in automatically Message-ID: <1339437107-25909-1-git-send-email-Matthieu.Moy@imag.fr> In-Reply-To: <7vzk897rqi.fsf@alter.siamese.dyndns.org> It was unclear whether the field was to be specified by the user of the API. Signed-off-by: Matthieu Moy --- > It is correct that the C API asks helpers that the user configured, > but I think it is common across three API functions, not limited to > credential_fill(). credential_apply_config() is called from approve > and reject, too. Ah, right, so compared to v1, we can move the sentence to the description of the "helpers" field, like this: 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..48f51ed 100644 --- a/Documentation/technical/api-credentials.txt +++ b/Documentation/technical/api-credentials.txt @@ -21,7 +21,9 @@ 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. + This struct should always be initialized with `CREDENTIAL_INIT` or `credential_init`. -- 1.7.11.rc0.57.g84a04c7