Re: [PATCH] Expand on impact of threads on memory consumption.

From: Robert de Bath <robert@tvisiontech.co.uk>
Date: Oct 24, 2014, 17:51 UTC
Message-ID: <3F70E0BBE32F764BA89060B84135BD471850D9E1@TVTEX10.tvt.local>

> ... text unnecessarily opaque ...

Yes, that's quite likely. However, I think you should continue to have a similar form to the previous 'pack.window' and 'pack.depth' descriptions... perhaps:

    The maximum size of memory that is consumed by each
    thread in linkgit:git-pack-objects[1] for pack window memory
    when no limit is given on the command line.
    The value can be suffixed with "k", "m", or "g".  When left
    unconfigured, there will be no limit.

Though, I suspect the existing wording is trying to avoid saying there's a 'default' and another 'default' which would be covered by your rewording.

So I have no real problem either way.

Robert.
 
________________________________________
From: Junio C Hamano [gitster@pobox.com]
Sent: 24 October 2014 18:27
To: Robert de Bath
Cc: git@vger.kernel.org
Subject: [NOTWHITELIST] Re: [PATCH] Expand on impact of threads on memory consumption.

Robert de Bath <rdebath@tvisiontech.co.uk> writes:

Show 15 quoted lines

> diff --git a/Documentation/config.txt b/Documentation/config.txt
> index c55c22a..6384038 100644
> --- a/Documentation/config.txt
> +++ b/Documentation/config.txt
> @@ -1828,7 +1828,10 @@ pack.depth::
>
>  pack.windowMemory::
>       The window memory size limit used by linkgit:git-pack-objects[1]
> -     when no limit is given on the command line.  The value can be
> +     when no limit is given on the command line.  This limit may be
> +     allocated individually by each thread doing delta compression
> +     so the total memory allocated by linkgit:git-pack-objects[1] can
> +     be this multiplied by the number of threads.  The value can be
>       suffixed with "k", "m", or "g".  Defaults to 0, meaning no
>       limit.

I sense that this change makes the resulting text unnecessarily opaque by avoiding touching the first sentence. Wouldn't something more concise like this sufficient?

    The default maximum size of memory that is consumed by each
    thread in linkgit:git-pack-objects[1] for pack window memory.
    The value can be suffixed with "k", "m", or "g".  When left
    unconfigured, there will be no limit.