summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarlo Marcelo Arenas Belón <carenas@gmail.com>2020-05-05 01:39:05 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-05-05 05:56:32 (GMT)
commit7f53583834f991eadcc371932e117317cb3c65c5 (patch)
treede760720e840c621800512807651c7820c66cfc2
parentaf6b65d45ef179ed52087e80cb089f6b2349f4ec (diff)
downloadgit-7f53583834f991eadcc371932e117317cb3c65c5.zip
git-7f53583834f991eadcc371932e117317cb3c65c5.tar.gz
git-7f53583834f991eadcc371932e117317cb3c65c5.tar.bz2
credential: update description for credential_from_url_gently
c44088ecc4 (credential: treat URL without scheme as invalid, 2020-04-18) changes the implementation for this function to return -1 if protocol is missing. Update blurb to match implementation. Reviewed-by: Jeff King <peff@peff.net> Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--credential.h4
1 files changed, 2 insertions, 2 deletions
diff --git a/credential.h b/credential.h
index d99ec42..f51703d 100644
--- a/credential.h
+++ b/credential.h
@@ -177,8 +177,8 @@ void credential_write(const struct credential *, FILE *);
* Parse a url into a credential struct, replacing any existing contents.
*
* If the url can't be parsed (e.g., a missing "proto://" component), the
- * resulting credential will be empty but we'll still return success from the
- * "gently" form.
+ * resulting credential will be empty and the function will return an
+ * error (even in the "gently" form).
*
* If we encounter a component which cannot be represented as a credential
* value (e.g., because it contains a newline), the "gently" form will return