summaryrefslogtreecommitdiffstats
path: root/git-credential.txt
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.txt
parentbb300643ea913f58d836780e949b1ebcce8da530 (diff)
downloadgit-htmldocs-44dcd493a7896aabe2b48b0a2935633538d81f7c.tar.gz
Autogenerated HTML docs for v1.7.12-rc0
Diffstat (limited to 'git-credential.txt')
-rw-r--r--git-credential.txt22
1 files changed, 16 insertions, 6 deletions
diff --git a/git-credential.txt b/git-credential.txt
index a81684e15..53adee320 100644
--- a/git-credential.txt
+++ b/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`::
@@ -142,3 +140,15 @@ sense when dealing with a non-network protocol):
`password`::
The credential's password, if we are asking it to be stored.
+
+`url`::
+
+ When this special attribute is read by `git credential`, the
+ 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.