Re: [PATCH] document git-repack interaction of pack.threads and pack.windowMemory

[Junio C Hamano <gitster@pobox.com>]

Michael Stahl <mstahl@redhat.com> writes:

> Signed-off-by: Michael Stahl <mstahl@redhat.com>
> ---
>  Documentation/git-pack-objects.txt | 2 +-
>  Documentation/git-repack.txt       | 6 +++++-
>  2 files changed, 6 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-pack-objects.txt b/Documentation/git-pack-objects.txt
> index 19cdcd0..0b655a5 100644
> --- a/Documentation/git-pack-objects.txt
> +++ b/Documentation/git-pack-objects.txt
> @@ -105,7 +105,7 @@ base-name::
>  	advantage of the large window for the smaller objects.  The
>  	size can be suffixed with "k", "m", or "g".
>  	`--window-memory=0` makes memory usage unlimited, which is the
> -	default.
> +	default, unless the config variable `pack.windowMemory` is set.

That does not go far enough as it does not say what happens when the
variable is set (i.e. "the variable serves as the default in that
case").

Perhaps "...makes memory usage unlimited.  The default is taken from
the `pack.windowMemory` configuration variable." would make it better,
as it is described that its default is "unlimited".

> diff --git a/Documentation/git-repack.txt b/Documentation/git-repack.txt
> index c597523..300455b 100644
> --- a/Documentation/git-repack.txt
> +++ b/Documentation/git-repack.txt
> @@ -101,7 +101,11 @@ other objects in that pack they already have locally.
>  	advantage of the large window for the smaller objects.  The
>  	size can be suffixed with "k", "m", or "g".
>  	`--window-memory=0` makes memory usage unlimited, which is the
> -	default.
> +	default, unless the config variable `pack.windowMemory` is set.
> +	Note that the actual memory usage will be multiplied
> +	by the number of threads used by linkgit:git-pack-objects[1],
> +	which is lacking a corresponding git-repack flag but can be
> +	set via the config variable `pack.threads`.

I think the same comment applies to the first line.  The next two
lines are definite improvement, but I do not think the last two
lines are necessary.