summaryrefslogtreecommitdiffstats
path: root/git-credential.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2012-07-23 21:35:38 -0700
committerJunio C Hamano <gitster@pobox.com>2012-07-23 21:35:38 -0700
commit44dcd493a7896aabe2b48b0a2935633538d81f7c (patch)
tree55fb9bfad3faa4309b5e1c0781f78d635c6dbd3b /git-credential.html
parentbb300643ea913f58d836780e949b1ebcce8da530 (diff)
downloadgit-htmldocs-44dcd493a7896aabe2b48b0a2935633538d81f7c.tar.gz
Autogenerated HTML docs for v1.7.12-rc0
Diffstat (limited to 'git-credential.html')
-rw-r--r--git-credential.html28
1 files changed, 21 insertions, 7 deletions
diff --git a/git-credential.html b/git-credential.html
index b0765d06f..2a249ef8e 100644
--- a/git-credential.html
+++ b/git-credential.html
@@ -684,21 +684,19 @@ Report on the success or failure of the password. If the
<h2 id="IOFMT">INPUT/OUTPUT FORMAT</h2>
<div class="sectionbody">
<div class="paragraph"><p><tt>git credential</tt> 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 <tt>git credential</tt> will obtain
the login/password information (e.g. host, protocol, path), or to the
actual credential data to be obtained (login/password).</p></div>
-<div class="paragraph"><p>The credential is split into a set of named attributes.
-Attributes are provided to the helper, one per line. Each attribute is
+<div class="paragraph"><p>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 <tt>=</tt> (equals) sign,
followed by a newline. The key may contain any bytes except <tt>=</tt>,
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 <tt>host</tt> attribute makes no
-sense when dealing with a non-network protocol):</p></div>
+Git understands the following attributes:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<tt>protocol</tt>
@@ -744,13 +742,29 @@ sense when dealing with a non-network protocol):</p></div>
The credential&#8217;s password, if we are asking it to be stored.
</p>
</dd>
+<dt class="hdlist1">
+<tt>url</tt>
+</dt>
+<dd>
+<p>
+ When this special attribute is read by <tt>git credential</tt>, the
+ value is parsed as a URL and treated as if its constituent parts
+ were read (e.g., <tt>url=https://example.com</tt> would behave as if
+ <tt>protocol=https</tt> and <tt>host=example.com</tt> 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.
+</p>
+</dd>
</dl></div>
</div>
</div>
<div id="footnotes"><hr /></div>
<div id="footer">
<div id="footer-text">
-Last updated 2012-07-09 13:33:29 PDT
+Last updated 2012-07-23 21:34:17 PDT
</div>
</div>
</body>