git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH] api-credential.txt: document that helpers field is filled-in automatically
Date: Mon, 11 Jun 2012 12:46:14 +0200	[thread overview]
Message-ID: <1339411574-22998-1-git-send-email-Matthieu.Moy@imag.fr> (raw)

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).

 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

             reply	other threads:[~2012-06-11 10:46 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-06-11 10:46 Matthieu Moy [this message]
2012-06-11 16:12 ` [PATCH] api-credential.txt: document that helpers field is filled-in automatically Junio C Hamano
2012-06-11 17:51   ` Matthieu Moy
2012-06-11 19:08     ` Jeff King
2012-06-12  9:39       ` Matthieu Moy
2012-06-12 14:48         ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1339411574-22998-1-git-send-email-Matthieu.Moy@imag.fr \
    --to=matthieu.moy@imag.fr \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).