Skip to content

Commit bd1b88d

Browse files
peffgitster
authored andcommitted
config: document remote.*.url/pushurl interaction
The documentation for these keys gives a very terse definition and points you to the fetch/push manpages. But from reading those pages it was not at all obvious to me that: - these are keys that can be defined multiple times with meaningful behavior (especially remote.*.url) - the way that pushurl overrides url (the git-push page does mention that "pushurl defaults to url", but it is not immediately clear what a multi-valued url would do in that situation). Let's try to summarize the current behavior. Signed-off-by: Jeff King <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b68118d commit bd1b88d

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

Documentation/config/remote.txt

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,16 @@ remote.pushDefault::
55

66
remote.<name>.url::
77
The URL of a remote repository. See linkgit:git-fetch[1] or
8-
linkgit:git-push[1].
8+
linkgit:git-push[1]. A configured remote can have multiple URLs;
9+
in this case the first is used for fetching, and all are used
10+
for pushing (assuming no `remote.<name>.pushurl` is defined).
911

1012
remote.<name>.pushurl::
1113
The push URL of a remote repository. See linkgit:git-push[1].
14+
If a `pushurl` option is present in a configured remote, it
15+
is used for pushing instead of `remote.<name>.url`. A configured
16+
remote can have multiple push URLs; in this case a push goes to
17+
all of them.
1218

1319
remote.<name>.proxy::
1420
For remotes that require curl (http, https and ftp), the URL to

0 commit comments

Comments
 (0)