Skip to content

Commit

Permalink
credential: update description for credential_from_url_gently
Browse files Browse the repository at this point in the history
c44088e (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>
  • Loading branch information
carenas authored and gitster committed May 5, 2020
1 parent af6b65d commit 7f53583
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions credential.h
Expand Up @@ -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
Expand Down

0 comments on commit 7f53583

Please sign in to comment.