doc/git-config: add unit for http.lowSpeedLimit
PATCH 1/1 doc/git-config: add unit for http.lowSpeedLimit
From: Corentin Garcia <[email protected]>
Add the unit (bytes per second) for http.lowSpeedLimit in the documentation.
---
doc/git-config: add unit for http.lowSpeedLimit
Add the unit (bytes per second) for http.lowSpeedLimit in the documentation.
Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1507%2Fcorenting%2Fmaster-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1507/corenting/master-v1
Pull-Request: https://github.com/git/git/pull/1507
Documentation/config/http.txt | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
Documentation/config/http.txt +3 -2
@@ -246,8 +246,9 @@ 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' - for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. + If the HTTP transfer speed, in bytes per second, is less than + 'http.lowSpeedLimit' for longer than 'http.lowSpeedTime' seconds, + the transfer is aborted. Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and `GIT_HTTP_LOW_SPEED_TIME` environment variables.
base-commit: 5597cfdf47db94825213fefe78c4485e6a5702d8
Signature · 1 line
gitgitgadget
Quoted 7 lines · Corentin Garcia via GitGitGadget
From: Corentin Garcia <[email protected]>
Add the unit (bytes per second) for http.lowSpeedLimit in the documentation.
Signed-off-by Corentin Garcia <[email protected]>---
SOunds good.
Quoted 4 lines
doc/git-config: add unit for http.lowSpeedLimit
Add the unit (bytes per second) for http.lowSpeedLimit in the documentation.
You do not have to repeat your log message here.
Quoted 5 lines
Documentation/config/http.txt +0
-0
Documentation/config/http.txt significantly since the entire buffer is allocated even for small · line 253
Quoted 10 lines
Documentation/config/http.txt +3
-2@@ -246,8 +246,9 @@ 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' - for longer than 'http.lowSpeedTime' seconds, the transfer is aborted. + If the HTTP transfer speed, in bytes per second, is less than + 'http.lowSpeedLimit' for longer than 'http.lowSpeedTime' seconds, + the transfer is aborted. Can be overridden by the `GIT_HTTP_LOW_SPEED_LIMIT` and `GIT_HTTP_LOW_SPEED_TIME` environment variables.
As the variable is read with git_config_int(), this also allows the usual k/m/g suffix to scale, i.e. specifying it to 500k would mean 500*1024 bytes. I wonder if that is also worth documenting, or it is too obvious.
Let's queue this patch as-is. If somebody wants to elaborate on how the numbers can be spelled, that can be done in a separate patch.
Thanks.