path: root/Documentation/git-credential.txt
diff options
authorJeff King <>2012-07-18 12:06:26 (GMT)
committerJunio C Hamano <>2012-07-18 20:26:58 (GMT)
commit9c183a70722804114ac1dc54d17fe791ac1a452c (patch)
treeb48463c9c4bd5d7ecfff1aac55cd0715f02f8d5c /Documentation/git-credential.txt
parent6319a2a148adaa78f11414e914f8c9f3f1c52b5e (diff)
credential: convert "url" attribute into its parsed subparts
The git-credential command requires that you feed it a broken-down credential, which means that the client needs to parse a URL itself. Since we have our own URL-parsing routines, we can easily allow the caller to just give us the URL as-is, saving them some code. Signed-off-by: Jeff King <> Acked-by: Matthieu Moy <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'Documentation/git-credential.txt')
1 files changed, 12 insertions, 0 deletions
diff --git a/Documentation/git-credential.txt b/Documentation/git-credential.txt
index afd5365..53adee3 100644
--- a/Documentation/git-credential.txt
+++ b/Documentation/git-credential.txt
@@ -140,3 +140,15 @@ Git understands the following attributes:
The credential's password, if we are asking it to be stored.
+ 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=` would behave as if
+ `protocol=https` and `` 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.