{"thread":{"id":"56758","subject":"[PATCH v4] archive: describe compression level option","startedAt":"2021-10-22T06:47:49Z","lastAt":"2021-10-25T17:58:12Z","messageCount":6,"participants":["Bagas Sanjaya","Eric Sunshine","Junio C Hamano"],"isPatch":true,"patchVersion":4,"patchTotal":null},"messages":[{"id":"439343","messageId":"20211022064543.28950-1-bagasdotme@gmail.com","threadId":"56758","inReplyTo":null,"subject":"[PATCH v4] archive: describe compression level option","fromName":"Bagas Sanjaya","fromEmail":"bagasdotme@gmail.com","sentAt":"2021-10-22T06:45:44Z","receivedAt":"2021-10-22T06:47:49Z","isPatch":true,"sender":{"key":"bagasdotme@gmail.com","avatar":"https://avatars.githubusercontent.com/u/40219486?v=4"},"body":"Describe the only extra option in `git archive`, that is the compression\nlevel option. Previously this option is only described for zip backend;\nadd description also for tar backend.\n\nSigned-off-by: Bagas Sanjaya \n---\n Changes since v3 [1]:\n - use smaller size - slower time term\n - use and for compression level\n\n [1]: https://lore.kernel.org/git/xmqq8ryqxo72.fsf@gitster.g/T/#t\n Documentation/git-archive.txt | 17 ++++++++++++-----\n 1 file changed, 12 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt\nindex 9f8172828d..ecfae7e268 100644\n--- a/Documentation/git-archive.txt\n+++ b/Documentation/git-archive.txt\n@@ -93,12 +93,19 @@ BACKEND EXTRA OPTIONS\n \n zip\n ~~~\n--0::\n-\tStore the files instead of deflating them.\n--9::\n-\tHighest and slowest compression level. You can specify any\n-\tnumber from 1 to 9 to adjust compression speed and ratio.\n+-::\n+\tRegulate compression level using the specified . Higher\n+\tvalues enables smaller size at the expense of slower time.\n+\tSupported values are from `-0` (store-only) to `-9` (best ratio).\n+\tDefault is `-6` if isn't specified.\n \n+tar\n+~~~\n+-::\n+\tSpecify compression level. The value will be passed to the\n+\tcompression command configured in `tar..command`. See\n+\tmanual page of the configured command for the list of supported\n+\tlevels and the default level if this option isn't specified.\n \n CONFIGURATION\n -------------\n\nbase-commit: f443b226ca681d87a3a31e245a70e6bc2769123c\n-- \nAn old man doll... just what I always wanted! - Clara\n\n"},{"id":"439345","messageId":"CAPig+cRAi4ZR+_+Dh+DoUBkG=sgWTekxadob2YvThJQhr9tqfA@mail.gmail.com","threadId":"56758","inReplyTo":"20211022064543.28950-1-bagasdotme@gmail.com","subject":"Re: [PATCH v4] archive: describe compression level option","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-10-22T06:57:07Z","receivedAt":"2021-10-22T06:57:21Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Fri, Oct 22, 2021 at 2:48 AM Bagas Sanjaya wrote:\n> Describe the only extra option in `git archive`, that is the compression\n> level option. Previously this option is only described for zip backend;\n> add description also for tar backend.\n>\n> Signed-off-by: Bagas Sanjaya \n> ---\n> diff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt\n> @@ -93,12 +93,19 @@ BACKEND EXTRA OPTIONS\n> zip\n> ~~~\n> +-::\n> + Regulate compression level using the specified . Higher\n> + values enables smaller size at the expense of slower time.\n\ns/enables/enable/\n\nA couple notes:\n\n\"slower time\" is an unusual way to convey the concept; perhaps say it\ntakes \"more time\".\n\nI think it was mentioned earlier in this thread that higher\ncompression level does not necessarily mean better compression, though\nthat is certainly the intent; it only means that the tool will \"try\nharder\" to make the result smaller. Perhaps it's worth using more\nexact phrasing (or perhaps it doesn't matter and that's getting too\nmuch into the weeds).\n\n> + Supported values are from `-0` (store-only) to `-9` (best ratio).\n> + Default is `-6` if isn't specified.\n\ns/if isn't/if it isn't/\n...or...\ns/if isn't/if not/\n\n> +tar\n> +~~~\n> +-::\n> + Specify compression level. The value will be passed to the\n> + compression command configured in `tar..command`. See\n> + manual page of the configured command for the list of supported\n> + levels and the default level if this option isn't specified.\n"},{"id":"439460","messageId":"xmqqcznvbg2m.fsf@gitster.g","threadId":"56758","inReplyTo":"CAPig+cRAi4ZR+_+Dh+DoUBkG=sgWTekxadob2YvThJQhr9tqfA@mail.gmail.com","subject":"Re: [PATCH v4] archive: describe compression level option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-10-23T21:13:05Z","receivedAt":"2021-10-23T21:13:12Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine writes:\n\n>> +-::\n>> + Regulate compression level using the specified . Higher\n>> + values enables smaller size at the expense of slower time.\n>\n> s/enables/enable/\n>\n> A couple notes:\n>\n> \"slower time\" is an unusual way to convey the concept; perhaps say it\n> takes \"more time\".\n>\n> I think it was mentioned earlier in this thread that higher\n> compression level does not necessarily mean better compression, though\n> that is certainly the intent; it only means that the tool will \"try\n> harder\" to make the result smaller. Perhaps it's worth using more\n> exact phrasing (or perhaps it doesn't matter and that's getting too\n> much into the weeds).\n>\n>> + Supported values are from `-0` (store-only) to `-9` (best ratio).\n>> + Default is `-6` if isn't specified.\n>\n> s/if isn't/if it isn't/\n> ...or...\n> s/if isn't/if not/\n\nSounds all sensible.\n\nIn summary, perhaps something like this? I still have \"-9 (best\nratio)\" which does not say it is merely the intent and not\nguarantee, but the resulting text read a bit funny with \"best ratio\"\nreplaced with \"try hardest\".\n\n----- >8 --------- >8 --------- >8 --------- >8 --------- >8 -----\nFrom: Bagas Sanjaya \nDate: Fri, 22 Oct 2021 13:45:44 +0700\nSubject: [PATCH] archive: describe compression level option\n\nDescribe the only option in `git archive`, that is the compression\nlevel option. Previously this option is only described for zip backend;\nadd description also for tar backend.\n\nSigned-off-by: Bagas Sanjaya \nHelped-by: Eric Sunshine \nSigned-off-by: Junio C Hamano \n---\n$ git range-diff --word-diff @{1}...\n1: c27c11dc35 ! 1: 63e8b48637 archive: describe compression level option\n @@ Metadata\n ## Commit message ##\n archive: describe compression level option\n \n Describe the only [-extra-]{++} option in `git archive`, that is the compression\n level option. Previously this option is only described for zip backend;\n add description also for tar backend.\n \n @@ Documentation/git-archive.txt: BACKEND EXTRA OPTIONS\n -\tHighest and slowest compression level. You can specify any\n -\tnumber from 1 to 9 to adjust compression speed and ratio.\n +-::\n +\t[-Regulate-]{+Specify+} compression [-level using the specified . Higher-]\n [-+-]{+level. Larger+} values [-enables smaller size at-]{+allows+} the [-expense of slower time.-]{+command+}\n +\t{+to spend more time to compress to smaller size.+} Supported\n{+++}\tvalues are from `-0` (store-only) to `-9` (best ratio).\n +\tDefault is `-6` if [-isn't specified.-]{+not given.+}\n \n +tar\n +~~~\n\n Documentation/git-archive.txt | 17 ++++++++++++-----\n 1 file changed, 12 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-archive.txt b/Documentation/git-archive.txt\nindex 9f8172828d..fea2e84fdf 100644\n--- a/Documentation/git-archive.txt\n+++ b/Documentation/git-archive.txt\n@@ -93,12 +93,19 @@ BACKEND EXTRA OPTIONS\n \n zip\n ~~~\n--0::\n-\tStore the files instead of deflating them.\n--9::\n-\tHighest and slowest compression level. You can specify any\n-\tnumber from 1 to 9 to adjust compression speed and ratio.\n+-::\n+\tSpecify compression level. Larger values allows the command\n+\tto spend more time to compress to smaller size. Supported\n+\tvalues are from `-0` (store-only) to `-9` (best ratio).\n+\tDefault is `-6` if not given.\n \n+tar\n+~~~\n+-::\n+\tSpecify compression level. The value will be passed to the\n+\tcompression command configured in `tar..command`. See\n+\tmanual page of the configured command for the list of supported\n+\tlevels and the default level if this option isn't specified.\n \n CONFIGURATION\n -------------\n-- \n2.33.1-943-g0f03e78e89\n\n"},{"id":"439556","messageId":"CAPig+cQ8NEKY3nwuFi_7Hc7L7rnbcUShf3zw60PvBB8LOPEgPA@mail.gmail.com","threadId":"56758","inReplyTo":"xmqqcznvbg2m.fsf@gitster.g","subject":"Re: [PATCH v4] archive: describe compression level option","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-10-25T16:39:07Z","receivedAt":"2021-10-25T16:39:23Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Sat, Oct 23, 2021 at 5:13 PM Junio C Hamano wrote:\n> Eric Sunshine writes:\n> >> +-::\n> >> + Regulate compression level using the specified . Higher\n> >> + values enables smaller size at the expense of slower time.\n> >\n> > s/enables/enable/\n> >\n> > A couple notes:\n> >\n> > \"slower time\" is an unusual way to convey the concept; perhaps say it\n> > takes \"more time\".\n> > [...]\n> >> + Supported values are from `-0` (store-only) to `-9` (best ratio).\n> >> + Default is `-6` if isn't specified.\n> >\n> > s/if isn't/if it isn't/\n> > ...or...\n> > s/if isn't/if not/\n>\n> Sounds all sensible.\n>\n> In summary, perhaps something like this? I still have \"-9 (best\n> ratio)\" which does not say it is merely the intent and not\n> guarantee, but the resulting text read a bit funny with \"best ratio\"\n> replaced with \"try hardest\".\n\nThis version looks fine. Thanks.\n"},{"id":"439570","messageId":"xmqqsfwp0zcv.fsf@gitster.g","threadId":"56758","inReplyTo":"CAPig+cQ8NEKY3nwuFi_7Hc7L7rnbcUShf3zw60PvBB8LOPEgPA@mail.gmail.com","subject":"Re: [PATCH v4] archive: describe compression level option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2021-10-25T17:48:48Z","receivedAt":"2021-10-25T17:49:09Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Eric Sunshine writes:\n\n>> In summary, perhaps something like this? I still have \"-9 (best\n>> ratio)\" which does not say it is merely the intent and not\n>> guarantee, but the resulting text read a bit funny with \"best ratio\"\n>> replaced with \"try hardest\".\n>\n> This version looks fine. Thanks.\n\nThanks for proofreading. I have locally fixed a grammo (\"Larger\nvalues allow the command\"), by the way.\n\n\n"},{"id":"439572","messageId":"CAPig+cSiAM5wq0+wcpdaEHpyXwJkC2j0WnErf_hS0ZXsjUxA_A@mail.gmail.com","threadId":"56758","inReplyTo":"xmqqsfwp0zcv.fsf@gitster.g","subject":"Re: [PATCH v4] archive: describe compression level option","fromName":"Eric Sunshine","fromEmail":"sunshine@sunshineco.com","sentAt":"2021-10-25T17:57:58Z","receivedAt":"2021-10-25T17:58:12Z","isPatch":true,"sender":{"key":"sunshine@sunshineco.com","avatar":"https://avatars.githubusercontent.com/u/163641?v=4"},"body":"On Mon, Oct 25, 2021 at 1:49 PM Junio C Hamano wrote:\n> Eric Sunshine writes:\n> >> In summary, perhaps something like this? I still have \"-9 (best\n> >> ratio)\" which does not say it is merely the intent and not\n> >> guarantee, but the resulting text read a bit funny with \"best ratio\"\n> >> replaced with \"try hardest\".\n> >\n> > This version looks fine. Thanks.\n>\n> Thanks for proofreading. I have locally fixed a grammo (\"Larger\n> values allow the command\"), by the way.\n\nBleh. My eyes slid right over that grammo. Oh well.\n\nWith that grammo fix, it looks even better.\n"}]}