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>
This commit is contained in:
parent
af6b65d45e
commit
7f53583834
@ -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
|
||||
|
Loading…
Reference in New Issue
Block a user