v4archive: describe compression level option

Describe the only extra option in `git archive`, that is the compression level option. Previously this option is only described for zip backend; add description also for tar backend.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 Changes since v3 [1]:
     - use smaller size - slower time term
     - use <digit> and <number> for compression level

 [1]: https://lore.kernel.org/git/xmqq8ryqxo72.fsf@gitster.g/T/#t
 Documentation/git-archive.txt | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

On Fri, Oct 22, 2021 at 2:48 AM Bagas Sanjaya <bagasdotme@gmail.com> wrote:

s/enables/enable/

A couple notes:

"slower time" is an unusual way to convey the concept; perhaps say it takes "more time".

I think it was mentioned earlier in this thread that higher compression level does not necessarily mean better compression, though that is certainly the intent; it only means that the tool will "try harder" to make the result smaller. Perhaps it's worth using more exact phrasing (or perhaps it doesn't matter and that's getting too much into the weeds).

s/if isn't/if it isn't/ ...or... s/if isn't/if not/

Eric Sunshine <sunshine@sunshineco.com> writes:

Sounds all sensible.

In summary, perhaps something like this? I still have "-9 (best ratio)" which does not say it is merely the intent and not guarantee, but the resulting text read a bit funny with "best ratio" replaced with "try hardest".

----- >8 --------- >8 --------- >8 --------- >8 --------- >8 -----
From: Bagas Sanjaya <bagasdotme@gmail.com>
Date: Fri, 22 Oct 2021 13:45:44 +0700
Subject: [PATCH] archive: describe compression level option

Describe the only <extra> option in `git archive`, that is the compression level option. Previously this option is only described for zip backend; add description also for tar backend.

Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Helped-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
$ git range-diff --word-diff @{1}...
1:  c27c11dc35 ! 1:  63e8b48637 archive: describe compression level option
    @@ Metadata
     ## Commit message ##
        archive: describe compression level option
    
        Describe the only [-extra-]{+<extra>+} option in `git archive`, that is the compression
        level option. Previously this option is only described for zip backend;
        add description also for tar backend.
    
    @@ Documentation/git-archive.txt: BACKEND EXTRA OPTIONS
    -	Highest and slowest compression level.  You can specify any
    -	number from 1 to 9 to adjust compression speed and ratio.
    +-<digit>::
    +	[-Regulate-]{+Specify+} compression [-level using the specified <digit>. Higher-]
    [-+-]{+level.  Larger+} values [-enables smaller size at-]{+allows+} the [-expense of slower time.-]{+command+}
    +	{+to spend more time to compress to smaller size.+}  Supported
{+++}	values are from `-0` (store-only) to `-9` (best ratio).
    +	Default is `-6` if [-isn't specified.-]{+not given.+}
     
    +tar
    +~~~

 Documentation/git-archive.txt | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)

On Sat, Oct 23, 2021 at 5:13 PM Junio C Hamano <gitster@pobox.com> wrote:

This version looks fine. Thanks.

Eric Sunshine <sunshine@sunshineco.com> writes:

Thanks for proofreading. I have locally fixed a grammo ("Larger values allow the command"), by the way.

On Mon, Oct 25, 2021 at 1:49 PM Junio C Hamano <gitster@pobox.com> wrote:

Bleh. My eyes slid right over that grammo. Oh well.

With that grammo fix, it looks even better.