summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2024-07-10 01:37:46 +0200
committerJunio C Hamano <gitster@pobox.com>2024-07-10 06:24:42 +0200
commit70405acf60ca20de1aaf0fe67440de93ee2318e6 (patch)
treed4fd4b694ea1ae8b521786e52069b304988ae5e0
parentgitfaq: add entry about syncing working trees (diff)
downloadgit-70405acf60ca20de1aaf0fe67440de93ee2318e6.tar.xz
git-70405acf60ca20de1aaf0fe67440de93ee2318e6.zip
doc: mention that proxies must be completely transparent
We already document in the FAQ that proxies must be completely transparent and not modify the request or response in any way, but add similar documentation to the http.proxy entry. We know that while the FAQ is very useful, users sometimes are less likely to read in favor of the documentation specific to an option or command, so adding it in both places will help users be adequately informed. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/config/http.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt
index 2d4e0c9b86..a9c7480f6a 100644
--- a/Documentation/config/http.txt
+++ b/Documentation/config/http.txt
@@ -7,6 +7,11 @@ http.proxy::
linkgit:gitcredentials[7] for more information. The syntax thus is
'[protocol://][user[:password]@]proxyhost[:port]'. This can be overridden
on a per-remote basis; see remote.<name>.proxy
++
+Any proxy, however configured, must be completely transparent and must not
+modify, transform, or buffer the request or response in any way. Proxies which
+are not completely transparent are known to cause various forms of breakage
+with Git.
http.proxyAuthMethod::
Set the method with which to authenticate against the HTTP proxy. This