From: Jeff King <peff@peff.net>
To: "Carlo Marcelo Arenas Belón" <carenas@gmail.com>
Cc: git@vger.kernel.org, jrnieder@gmail.com
Subject: Re: [PATCH 4/4] credential: document protocol updates
Date: Wed, 6 May 2020 12:26:48 -0400 [thread overview]
Message-ID: <20200506162648.GA1275237@coredump.intra.peff.net> (raw)
In-Reply-To: <20200505013908.4596-5-carenas@gmail.com>
On Mon, May 04, 2020 at 06:39:08PM -0700, Carlo Marcelo Arenas Belón wrote:
> Document protocol changes after CVE-2020-11008, while at it do some
> minor improvements for clarity and consitency.
s/consitency/consistency/s
I think the overall direction is good. A few small comments below.
> `host`::
>
> - The remote hostname for a network credential.
> + The remote hostname for a network credential. This includes
> + the port number if one was specified.
It might be worth giving an example of the syntax, like:
the port number if one was specified (e.g., "example.com:8088").
> @@ -146,8 +147,11 @@ Git understands the following attributes:
> value is parsed as a URL and treated as if its constituent parts
> were read (e.g., `url=https://example.com` would behave as if
> `protocol=https` and `host=example.com` had been provided). This
> - can help callers avoid parsing URLs themselves. Note that any
> - components which are missing from the URL (e.g., there is no
> - username in the example above) will be set to empty; if you want
> - to provide a URL and override some attributes, provide the URL
> - attribute first, followed by any overrides.
> + can help callers avoid parsing URLs themselves.
> +
> + Note that specifying a protocol is mandatory and if the URL
> + type doesn't require a hostname (like for cert://) then an
> + empty ("") hostname will be generated.
So we are losing the bit about overriding. I think that is OK, as we'd
like to avoid suggesting that is a good idea, and we may even remove the
feature in the future.
The word "generated" confused me a bit. Maybe something like:
...and if the URL doesn't specify a hostname (e.g.,
"cert:///path/to/file"), the credential will contain a hostname
attribute whose value is an empty string.
> + Components which are missing from the URL (e.g., there is no
> + username in the example above) will be left unset.
Makes sense.
-Peff
next prev parent reply other threads:[~2020-05-06 16:26 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-03 6:34 [RFC PATCH] credential: minor documentation fixes Carlo Marcelo Arenas Belón
2020-05-03 6:58 ` Jeff King
2020-05-04 7:45 ` Carlo Marcelo Arenas Belón
2020-05-04 14:44 ` Jeff King
2020-05-04 15:39 ` Carlo Marcelo Arenas Belón
2020-05-04 16:10 ` Jeff King
2020-05-04 15:58 ` Carlo Marcelo Arenas Belón
2020-05-04 16:13 ` Jeff King
2020-05-05 1:39 ` [PATCH 0/4] credential: documentation updates for maint Carlo Marcelo Arenas Belón
2020-05-05 1:39 ` [PATCH 1/4] credential: update description for credential_from_url_gently Carlo Marcelo Arenas Belón
2020-05-05 1:39 ` [PATCH 2/4] credential: correct order of parameters for credential_match Carlo Marcelo Arenas Belón
2020-05-05 1:39 ` [PATCH 3/4] credential: update gitcredentials documentation Carlo Marcelo Arenas Belón
2020-05-06 16:21 ` Jeff King
2020-05-05 1:39 ` [PATCH 4/4] credential: document protocol updates Carlo Marcelo Arenas Belón
2020-05-06 16:26 ` Jeff King [this message]
2020-05-06 16:27 ` [PATCH 0/4] credential: documentation updates for maint Jeff King
2020-05-06 23:28 ` Carlo Marcelo Arenas Belón
2020-05-07 20:59 ` Jeff King
2020-05-07 21:23 ` Carlo Marcelo Arenas Belón
2020-05-07 22:17 ` Jeff King
2020-05-07 23:35 ` Carlo Marcelo Arenas Belón
2020-05-06 21:47 ` [PATCH v2 " Carlo Marcelo Arenas Belón
2020-05-06 21:47 ` [PATCH v2 1/4] credential: update description for credential_from_url_gently Carlo Marcelo Arenas Belón
2020-05-06 21:47 ` [PATCH v2 2/4] credential: correct order of parameters for credential_match Carlo Marcelo Arenas Belón
2020-05-06 21:47 ` [PATCH v2 3/4] credential: update gitcredentials documentation Carlo Marcelo Arenas Belón
2020-05-07 20:54 ` Jeff King
2020-05-07 21:02 ` Junio C Hamano
2020-05-06 21:47 ` [PATCH v2 4/4] credential: document protocol updates Carlo Marcelo Arenas Belón
2020-05-07 20:57 ` Jeff King
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200506162648.GA1275237@coredump.intra.peff.net \
--to=peff@peff.net \
--cc=carenas@gmail.com \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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 read-only IMAP folder(s) and NNTP newsgroup(s).