From: "Carlo Marcelo Arenas Belón" <carenas@gmail.com>
To: git@vger.kernel.org
Cc: peff@peff.net, jrnieder@gmail.com,
"Carlo Marcelo Arenas Belón" <carenas@gmail.com>
Subject: [PATCH 4/4] credential: document protocol updates
Date: Mon, 4 May 2020 18:39:08 -0700 [thread overview]
Message-ID: <20200505013908.4596-5-carenas@gmail.com> (raw)
In-Reply-To: <20200505013908.4596-1-carenas@gmail.com>
Document protocol changes after CVE-2020-11008, while at it do some
minor improvements for clarity and consitency.
Signed-off-by: Carlo Marcelo Arenas Belón <carenas@gmail.com>
---
Documentation/git-credential.txt | 20 ++++++++++++--------
1 file changed, 12 insertions(+), 8 deletions(-)
diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt
index 6f0c7ca80f..73a287e634 100644
--- a/Documentation/git-credential.txt
+++ b/Documentation/git-credential.txt
@@ -104,7 +104,7 @@ INPUT/OUTPUT FORMAT
credential information in its standard input/output. This information
can correspond either to keys for which `git credential` will obtain
the login/password information (e.g. host, protocol, path), or to the
-actual credential data to be obtained (login/password).
+actual credential data to be obtained (username/password).
The credential is split into a set of named attributes, with one
attribute per line. Each attribute is
@@ -123,7 +123,8 @@ Git understands the following attributes:
`host`::
- The remote hostname for a network credential.
+ The remote hostname for a network credential. This includes
+ the port number if one was specified.
`path`::
@@ -134,7 +135,7 @@ Git understands the following attributes:
`username`::
The credential's username, if we already have one (e.g., from a
- URL, from the user, or from a previously run helper).
+ URL, the configuration, the user, or from a previously run helper).
`password`::
@@ -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.
+
+ Components which are missing from the URL (e.g., there is no
+ username in the example above) will be left unset.
--
2.26.2.686.gfaf46a9ccd
next prev parent reply other threads:[~2020-05-05 1:40 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 ` Carlo Marcelo Arenas Belón [this message]
2020-05-06 16:26 ` [PATCH 4/4] credential: document protocol updates Jeff King
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200505013908.4596-5-carenas@gmail.com \
--to=carenas@gmail.com \
--cc=git@vger.kernel.org \
--cc=jrnieder@gmail.com \
--cc=peff@peff.net \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.