docs/credential: minor clarity fixups
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> Acked-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Jul 18, 2012 at 08:04 UTC
3e5f29e8963a9a6f1774add194ec19583c19fbb6
1 file changed
+4
-6
Documentation/git-credential.txt
+4
-6
@@ -102,22 +102,20 @@ INPUT/OUTPUT FORMAT
102
-------------------
103
104
`git credential` reads and/or writes (depending on the action used)
105
-credential information in its standard input/output. These information
105
+credential information in its standard input/output. This information
106
can correspond either to keys for which `git credential` will obtain
107
the login/password information (e.g. host, protocol, path), or to the
108
actual credential data to be obtained (login/password).
109
110
-The credential is split into a set of named attributes.
111
-Attributes are provided to the helper, one per line. Each attribute is
110
+The credential is split into a set of named attributes, with one
111
+attribute per line. Each attribute is
112
specified by a key-value pair, separated by an `=` (equals) sign,
113
followed by a newline. The key may contain any bytes except `=`,
114
newline, or NUL. The value may contain any bytes except newline or NUL.
115
In both cases, all bytes are treated as-is (i.e., there is no quoting,
116
and one cannot transmit a value with newline or NUL in it). The list of
117
attributes is terminated by a blank line or end-of-file.
118
-Git will send the following attributes (but may not send all of
119
-them for a given credential; for example, a `host` attribute makes no
120
-sense when dealing with a non-network protocol):
118
+Git understands the following attributes:
119
120
`protocol`::
121