@matheusbsbs / matheus-bagliano / commits / 697f652818

Documentation/git-remote.txt: stress that set-url is not for triangular

It seems to be a common mistake to try using a single remote (e.g. 'origin') to fetch from one place (i.e. upstream) while pushing to another (i.e. your publishing point). That will never work satisfactorily, and it is easy to understand why if you think about what refs/remotes/origin/* would mean in such a world. It fundamentally cannot reflect the reality. If it follows the state of your upstream, it cannot match what you have published, and vice versa. It may be that misinformation is spread by some people. Let's counter them by adding a few words to our documentation. - The description was referring to <oldurl> and <newurl>, but never mentioned <name> argument you give from the command line. By mentioning "remote <name>", stress the fact that it is configuring a single remote. - Add a reminder that explicitly states that this is about a single remote, which the triangular workflow is not about. Signed-off-by: Junio C Hamano <gitster@pobox.com>

Junio C Hamano committed Jan 29, 2015 at 12:26 UTC 697f652818f211aa48e3c007f25d6177647980c1
1 file changed +14 -6
Documentation/git-remote.txt
+14 -6
@@ -130,17 +130,25 @@ branches, adds to that list.
130
131 'set-url'::
132
133 -Changes URL remote points to. Sets first URL remote points to matching
133 +Changes URLs for the remote. Sets first URL for remote <name> that matches
134 regex <oldurl> (first URL if no <oldurl> is given) to <newurl>. If
135 -<oldurl> doesn't match any URL, error occurs and nothing is changed.
135 +<oldurl> doesn't match any URL, an error occurs and nothing is changed.
136 +
137 With '--push', push URLs are manipulated instead of fetch URLs.
138 +
139 -With '--add', instead of changing some URL, new URL is added.
139 +With '--add', instead of changing existing URLs, new URL is added.
140 +
141 -With '--delete', instead of changing some URL, all URLs matching
142 -regex <url> are deleted. Trying to delete all non-push URLs is an
143 -error.
141 +With '--delete', instead of changing existing URLs, all URLs matching
142 +regex <url> are deleted for remote <name>. Trying to delete all
143 +non-push URLs is an error.
144 ++
145 +Note that the push URL and the fetch URL, even though they can
146 +be set differently, must still refer to the same place. What you
147 +pushed to the push URL should be what you would see if you
148 +immediately fetched from the fetch URL. If you are trying to
149 +fetch from one place (e.g. your upstream) and push to another (e.g.
150 +your publishing repository), use two separate remotes.
151 +
152
153 'show'::
154