Re: [PATCH v3 1/4] docs: clarify git-pack-refs --all will pack all refs

From: Taylor Blau <me@ttaylorr.com>
Date: May 11, 2023, 23:53 UTC
Message-ID: <ZF1/8w9DBNNrghPN@nand.local>
In-Reply-To: <0d462010b798f834fef55cc7aa767f3f2a177f91.1683828635.git.gitgitgadget@gmail.com>

On Thu, May 11, 2023 at 06:10:31PM +0000, John Cai via GitGitGadget wrote:

Show 21 quoted lines

> From: John Cai <johncai86@gmail.com>
>
> --all packs not just branch tips but anything under refs/ with the
> exception of hidden refs and broken refs. Clarify this in the
> documentation.
>
> Signed-off-by: John Cai <johncai86@gmail.com>
> ---
>  Documentation/git-pack-refs.txt | 7 ++++---
>  1 file changed, 4 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/git-pack-refs.txt b/Documentation/git-pack-refs.txt
> index 154081f2de2..e011e5fead3 100644
> --- a/Documentation/git-pack-refs.txt
> +++ b/Documentation/git-pack-refs.txt
> @@ -49,10 +49,11 @@ OPTIONS
>
>  The command by default packs all tags and refs that are already
>  packed, and leaves other refs
> -alone.  This is because branches are expected to be actively
> +alone. This is because branches are expected to be actively

This looks like a stray change.

Show 6 quoted lines

>  developed and packing their tips does not help performance.
> -This option causes branch tips to be packed as well.  Useful for
> -a repository with many branches of historical interests.
> +This option causes all refs to be packed as well, with the exception of hidden
> +and broken refs. Useful for a repository with many branches of historical
> +interests.

The new wording looks good, though you may want to mention that `--all` does not pack symrefs, either. That's not the fault of your patch, though, since it was the case in the pre-image, as well.

The wrapping on the new text looks a little off, though.

Thanks, Taylor