Re: [PATCH] api-credential.txt: document that helpers field is filled-in automatically
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Jun 11, 2012, 16:12 UTC
- Message-ID
- <7vzk897rqi.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <1339411574-22998-1-git-send-email-Matthieu.Moy@imag.fr>
Matthieu Moy <Matthieu.Moy@imag.fr> writes:
Show 8 quoted lines
> 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> > --- > > 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).
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.
Show 17 quoted lines
> 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`::