summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorbrian m. carlson <sandals@crustytoothpaste.net>2020-01-22 03:45:43 (GMT)
committerJunio C Hamano <gitster@pobox.com>2020-01-22 20:27:49 (GMT)
commit7a2dc95cbc25b4b82cff35931f69f8a5aafeb878 (patch)
treeaa6abf6c1bbfab0f8f2d56d7f7b43e00ce82930c
parent1b13e9032f039c8cdb1994dd092ff2ed32af5cf5 (diff)
downloadgit-7a2dc95cbc25b4b82cff35931f69f8a5aafeb878.zip
git-7a2dc95cbc25b4b82cff35931f69f8a5aafeb878.tar.gz
git-7a2dc95cbc25b4b82cff35931f69f8a5aafeb878.tar.bz2
docs: mention when increasing http.postBuffer is valuable
Users in a wide variety of situations find themselves with HTTP push problems. Oftentimes these issues are due to antivirus software, filtering proxies, or other man-in-the-middle situations; other times, they are due to simple unreliability of the network. However, a common solution to HTTP push problems found online is to increase http.postBuffer. This works for none of the aforementioned situations and is only useful in a small, highly restricted number of cases: essentially, when the connection does not properly support HTTP/1.1. Document when raising this value is appropriate and what it actually does, and discourage people from using it as a general solution for push problems, since it is not effective there. Signed-off-by: brian m. carlson <sandals@crustytoothpaste.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
-rw-r--r--Documentation/config/http.txt8
1 files changed, 8 insertions, 0 deletions
diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt
index 5a32f5b..3d1db91 100644
--- a/Documentation/config/http.txt
+++ b/Documentation/config/http.txt
@@ -199,6 +199,14 @@ http.postBuffer::
Transfer-Encoding: chunked is used to avoid creating a
massive pack file locally. Default is 1 MiB, which is
sufficient for most requests.
++
+Note that raising this limit is only effective for disabling chunked
+transfer encoding and therefore should be used only where the remote
+server or a proxy only supports HTTP/1.0 or is noncompliant with the
+HTTP standard. Raising this is not, in general, an effective solution
+for most push problems, but can increase memory consumption
+significantly since the entire buffer is allocated even for small
+pushes.
http.lowSpeedLimit, http.lowSpeedTime::
If the HTTP transfer speed is less than 'http.lowSpeedLimit'