From: Jeff King <peff@peff.net>
To: Matthieu Moy <Matthieu.Moy@imag.fr>
Cc: git@vger.kernel.org
Subject: [PATCH 1/4] docs/credential: minor clarity fixups
Date: Wed, 18 Jul 2012 08:04:02 -0400 [thread overview]
Message-ID: <20120718120401.GA6726@sigill.intra.peff.net> (raw)
In-Reply-To: <20120718120307.GA6399@sigill.intra.peff.net>
The text in git-credential(1) was copied from
technical/api-credentials, so it still talks about the
input/output format as coming from git to the helper. Since
the surrounding text already indicates that this format is
used for reading and writing with git credential, we can
just remove the extraneous confusing bits.
Signed-off-by: Jeff King <peff@peff.net>
---
Documentation/git-credential.txt | 10 ++++------
1 file changed, 4 insertions(+), 6 deletions(-)
diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt
index a81684e..afd5365 100644
--- a/Documentation/git-credential.txt
+++ b/Documentation/git-credential.txt
@@ -102,22 +102,20 @@ INPUT/OUTPUT FORMAT
-------------------
`git credential` reads and/or writes (depending on the action used)
-credential information in its standard input/output. These information
+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).
-The credential is split into a set of named attributes.
-Attributes are provided to the helper, one per line. Each attribute is
+The credential is split into a set of named attributes, with one
+attribute per line. Each attribute is
specified by a key-value pair, separated by an `=` (equals) sign,
followed by a newline. The key may contain any bytes except `=`,
newline, or NUL. The value may contain any bytes except newline or NUL.
In both cases, all bytes are treated as-is (i.e., there is no quoting,
and one cannot transmit a value with newline or NUL in it). The list of
attributes is terminated by a blank line or end-of-file.
-Git will send the following attributes (but may not send all of
-them for a given credential; for example, a `host` attribute makes no
-sense when dealing with a non-network protocol):
+Git understands the following attributes:
`protocol`::
--
1.7.10.5.40.g059818d
next prev parent reply other threads:[~2012-07-18 12:04 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-07-18 12:03 [PATCH 0/4] mediawiki/credential cleanups Jeff King
2012-07-18 12:04 ` Jeff King [this message]
2012-07-18 12:04 ` [PATCH 2/4] mw-to-git: check blank credential attributes via length Jeff King
2012-07-18 12:06 ` [PATCH 3/4] credential: convert "url" attribute into its parsed subparts Jeff King
2012-07-18 12:24 ` Matthieu Moy
2012-07-18 12:25 ` Jeff King
2012-07-18 12:06 ` [PATCH 4/4] mw-to-git: use git-credential's URL parser Jeff King
2012-07-18 12:24 ` Matthieu Moy
2012-07-18 12:28 ` Jeff King
2012-07-18 12:37 ` Matthieu Moy
2012-07-18 12:57 ` Jeff King
2012-07-18 13:03 ` [PATCHv2 " Jeff King
2012-07-18 13:06 ` Matthieu Moy
2012-07-18 13:05 ` [PATCH " Matthieu Moy
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=20120718120401.GA6726@sigill.intra.peff.net \
--to=peff@peff.net \
--cc=Matthieu.Moy@imag.fr \
--cc=git@vger.kernel.org \
/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 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 NNTP newsgroup(s).