Git Mailing List Archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: "Corentin Garcia via GitGitGadget" <gitgitgadget@gmail.com>
Cc: git@vger.kernel.org, Corentin Garcia <corenting@gmail.com>
Subject: Re: [PATCH] doc/git-config: add unit for http.lowSpeedLimit
Date: Mon, 15 May 2023 00:02:43 -0700	[thread overview]
Message-ID: <xmqqy1lq9iwc.fsf@gitster.g> (raw)
In-Reply-To: pull.1507.git.git.1683970203084.gitgitgadget@gmail.com

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


      reply	other threads:[~2023-05-15  7:03 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
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 message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqy1lq9iwc.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=corenting@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitgitgadget@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).