docs/config: mention protocol implications of url.insteadOf
commit2c9a2ae285b0806a5f754dcf6064f7cedc7e1fa8
authorJeff King <peff@peff.net>
Wed, 31 May 2017 05:18:04 +0000 (31 01:18 -0400)
committerJunio C Hamano <gitster@pobox.com>
Thu, 1 Jun 2017 01:07:10 +0000 (1 10:07 +0900)
tree88127a9d4b5beb5514b0158c7ec2d59e527a8797
parentb06d3643105c8758ed019125a4399cb7efdcce2c
docs/config: mention protocol implications of url.insteadOf

If a URL rewrite switches the protocol to something
nonstandard (like "persistent-https" for "https"), the user
may be bitten by the fact that the default protocol
restrictions are different between the two. Let's drop a
note in insteadOf that points the user in the right
direction.

It would be nice if we could make this work out of the box,
but we can't without knowing the security implications of
the user's rewrite. Only the documentation for a particular
remote helper can advise one way or the other. Since we do
include the persistent-https helper in contrib/ (and since
it was the helper in the real-world case that inspired that
patch), let's also drop a note there.

Suggested-by: Elliott Cable <me@ell.io>
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/config.txt
contrib/persistent-https/README