summaryrefslogtreecommitdiffstats
path: root/git-credential.html
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2020-05-14 16:03:19 -0700
committerJunio C Hamano <gitster@pobox.com>2020-05-14 16:03:19 -0700
commit306e76339fb038ce03be6ebac180746c67e83fe8 (patch)
treebc750056a598b1f350488282491fd8f8987774d1 /git-credential.html
parent2b43cff1c1e6418402997ad8a78ff0a401a5957a (diff)
downloadgit-htmldocs-306e76339fb038ce03be6ebac180746c67e83fe8.tar.gz
Autogenerated HTML docs for v2.27.0-rc0
Diffstat (limited to 'git-credential.html')
-rw-r--r--git-credential.html43
1 files changed, 26 insertions, 17 deletions
diff --git a/git-credential.html b/git-credential.html
index 90cffc0b0..96579cb52 100644
--- a/git-credential.html
+++ b/git-credential.html
@@ -857,17 +857,17 @@ Report on the success or failure of the password. If the
<div class="paragraph"><p><code>git credential</code> reads and/or writes (depending on the action used)
credential information in its standard input/output. This information
can correspond either to keys for which <code>git credential</code> will obtain
-the login/password information (e.g. host, protocol, path), or to the
-actual credential data to be obtained (login/password).</p></div>
+the login information (e.g. host, protocol, path), or to the actual
+credential data to be obtained (username/password).</p></div>
<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 <code>=</code> (equals) sign,
-followed by a newline. The key may contain any bytes except <code>=</code>,
-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,
+attribute per line. Each attribute is specified by a key-value pair,
+separated by an <code>=</code> (equals) sign, followed by a newline.</p></div>
+<div class="paragraph"><p>The key may contain any bytes except <code>=</code>, newline, or NUL. The value may
+contain any bytes except newline or NUL.</p></div>
+<div class="paragraph"><p>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 understands the following attributes:</p></div>
+attributes is terminated by a blank line or end-of-file.</p></div>
+<div class="paragraph"><p>Git understands the following attributes:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<code>protocol</code>
@@ -883,7 +883,8 @@ Git understands the following attributes:</p></div>
</dt>
<dd>
<p>
- The remote hostname for a network credential.
+ The remote hostname for a network credential. This includes
+ the port number if one was specified (e.g., "example.com:8088").
</p>
</dd>
<dt class="hdlist1">
@@ -902,7 +903,7 @@ Git understands the following attributes:</p></div>
<dd>
<p>
The credential&#8217;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).
</p>
</dd>
<dt class="hdlist1">
@@ -922,12 +923,20 @@ Git understands the following attributes:</p></div>
value is parsed as a URL and treated as if its constituent parts
were read (e.g., <code>url=https://example.com</code> would behave as if
<code>protocol=https</code> and <code>host=example.com</code> 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.
</p>
+<div class="literalblock">
+<div class="content">
+<pre><code>Note that specifying a protocol is mandatory 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.</code></pre>
+</div></div>
+<div class="literalblock">
+<div class="content">
+<pre><code>Components which are missing from the URL (e.g., there is no
+username in the example above) will be left unset.</code></pre>
+</div></div>
</dd>
</dl></div>
</div>
@@ -937,7 +946,7 @@ Git understands the following attributes:</p></div>
<div id="footer">
<div id="footer-text">
Last updated
- 2020-03-10 08:03:13 PDT
+ 2020-05-14 16:00:38 PDT
</div>
</div>
</body>