summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-06-05 09:03:15 +0900
committerJunio C Hamano <gitster@pobox.com>2017-06-05 09:03:15 +0900
commit7dab7c5b59d2b3e45ecda8cd47931db9dfc96ae2 (patch)
tree82f99132c71e2d06489d8817c8d727c3318b6c64
parentf72e075e300cd4fb74adf61d574fd2125c37e2eb (diff)
parent2c9a2ae285b0806a5f754dcf6064f7cedc7e1fa8 (diff)
downloadgit-7dab7c5b59d2b3e45ecda8cd47931db9dfc96ae2.tar.gz
Merge branch 'jk/url-insteadof-config' into maint
The interaction of "url.*.insteadOf" and custom URL scheme's whitelisting is now documented better. * jk/url-insteadof-config: docs/config: mention protocol implications of url.insteadOf
-rw-r--r--Documentation/config.txt7
-rw-r--r--contrib/persistent-https/README10
2 files changed, 17 insertions, 0 deletions
diff --git a/Documentation/config.txt b/Documentation/config.txt
index 65093ac22c..67f8c8fe51 100644
--- a/Documentation/config.txt
+++ b/Documentation/config.txt
@@ -3222,6 +3222,13 @@ url.<base>.insteadOf::
the best alternative for the particular user, even for a
never-before-seen repository on the site. When more than one
insteadOf strings match a given URL, the longest match is used.
++
+Note that any protocol restrictions will be applied to the rewritten
+URL. If the rewrite changes the URL to use a custom protocol or remote
+helper, you may need to adjust the `protocol.*.allow` config to permit
+the request. In particular, protocols you expect to use for submodules
+must be set to `always` rather than the default of `user`. See the
+description of `protocol.allow` above.
url.<base>.pushInsteadOf::
Any URL that starts with this value will not be pushed to;
diff --git a/contrib/persistent-https/README b/contrib/persistent-https/README
index f784dd2e66..7c4cd8d257 100644
--- a/contrib/persistent-https/README
+++ b/contrib/persistent-https/README
@@ -35,6 +35,16 @@ to use persistent-https:
[url "persistent-http"]
insteadof = http
+You may also want to allow the use of the persistent-https helper for
+submodule URLs (since any https URLs pointing to submodules will be
+rewritten, and Git's out-of-the-box defaults forbid submodules from
+using unknown remote helpers):
+
+[protocol "persistent-https"]
+ allow = always
+[protocol "persistent-http"]
+ allow = always
+
#####################################################################
# BUILDING FROM SOURCE