Git Mailing List Archive mirror
 help / color / mirror / Atom feed
* [PATCH] doc/git-config: add unit for http.lowSpeedLimit
@ 2023-05-13  9:30 Corentin Garcia via GitGitGadget
  2023-05-15  7:02 ` Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Corentin Garcia via GitGitGadget @ 2023-05-13  9:30 UTC (permalink / raw)
  To: git; +Cc: Corentin Garcia, Corentin Garcia

From: Corentin Garcia <corenting@gmail.com>

Add the unit (bytes per second) for http.lowSpeedLimit
in the documentation.

Signed-off-by: Corentin Garcia <corenting@gmail.com>
---
    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(-)

diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt
index afeeccfbfa7..51a70781e58 100644
--- a/Documentation/config/http.txt
+++ b/Documentation/config/http.txt
@@ -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
-- 
gitgitgadget

^ permalink raw reply related	[flat|nested] 2+ messages in thread

* Re: [PATCH] doc/git-config: add unit for http.lowSpeedLimit
  2023-05-13  9:30 [PATCH] doc/git-config: add unit for http.lowSpeedLimit Corentin Garcia via GitGitGadget
@ 2023-05-15  7:02 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2023-05-15  7:02 UTC (permalink / raw)
  To: Corentin Garcia via GitGitGadget; +Cc: git, Corentin Garcia

"Corentin Garcia via GitGitGadget" <gitgitgadget@gmail.com> writes:

> From: Corentin Garcia <corenting@gmail.com>
>
> Add the unit (bytes per second) for http.lowSpeedLimit
> in the documentation.
>
> Signed-off-by: Corentin Garcia <corenting@gmail.com>
> ---

SOunds good.

>     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.

> diff --git a/Documentation/config/http.txt b/Documentation/config/http.txt
> index afeeccfbfa7..51a70781e58 100644
> --- a/Documentation/config/http.txt
> +++ b/Documentation/config/http.txt
> @@ -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.


^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2023-05-15  7:03 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-05-13  9:30 [PATCH] doc/git-config: add unit for http.lowSpeedLimit Corentin Garcia via GitGitGadget
2023-05-15  7:02 ` Junio C Hamano

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).