Merge branch 'jc/doc-diff-blobs'
[gitweb.git] / Documentation / git-credential.txt
index afd53652556e9822533500bd7d5599beeacce177..810e957124feeb383e14e860aa1df46f99a03b5a 100644 (file)
@@ -3,7 +3,7 @@ git-credential(1)
 
 NAME
 ----
-git-credential - retrieve and store user credentials
+git-credential - Retrieve and store user credentials
 
 SYNOPSIS
 --------
@@ -140,3 +140,15 @@ Git understands the following attributes:
 `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.