Re: [PATCH] doc/git-config: add unit for http.lowSpeedLimit

From: Junio C Hamano <gitster@pobox.com>
Date: May 15, 2023, 07:02 UTC
Message-ID: <xmqqy1lq9iwc.fsf@gitster.g>
In-Reply-To: <pull.1507.git.git.1683970203084.gitgitgadget@gmail.com>

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

Show 7 quoted lines

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

Show 15 quoted lines

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