git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH RESEND] archive: rewrite description for compression level option

From
Bagas Sanjaya <bagasdotme@gmail.com>
Date
Oct 15, 2021, 03:22 UTC
Message-ID
<8e99fbef-32d0-9f19-4e57-1f28108c70cb@gmail.com>
In-Reply-To
<xmqqh7djczxr.fsf@gitster.g>
On 14/10/21 23.51, Junio C Hamano wrote:
Show 21 quoted lines
> Bagas Sanjaya <bagasdotme@gmail.com> writes:
> 
>> Currently, the description of compression level option (`-<number>` or
>> `-#`) only specifies two level (`-0` and `-9`), giving the impression
>> that only both levels are accepted, although other level number can be
>> specified. Rewrite the description.
> 
> While I find that the updated description is more detailed [*], I am
> not sure if the change to the heading is an improvement for readers,
> as I do not think of a case where users would choose to use anything
> other than to use (1) no compression level option, (2) '-0' for
> speed, or (3) '-9' for size, and explicitly singling out `-0` and
> `-9` like the current text does would help those who wonder what the
> option, used in a script written by somebody else that they are
> given to maintain, mean, better than the updated text that does not
> even allow /-9 in their pager to look for the description, if you
> only had `-<number>` or `-#`.
> 
> Also, unless we take `-47`, I do not think it is a good idea to
> spell it as `-<number>`.  Perhaps `-<digit>` is OK, but it shares
> exactly the same issue as `-<number>` I mentioned above.

Maybe we can say `-0 ... -9` to indicate the syntax, while both the endpoints are common but special case.

Also, we don't mention default compression level (`-6`?).
-- 
An old man doll... just what I always wanted! - Clara
Previous: Junio C HamanoNext: Ævar Arnfjörð Bjarmason
Message 3 of 5 in “archive: rewrite description for compression level option”
  1. archive: rewrite description for compression level optionBagas Sanjaya, Oct 14, 2021
  2. Junio C HamanoOct 14, 2021
  3. Bagas SanjayaOct 15, 2021
  4. Ævar Arnfjörð BjarmasonOct 15, 2021
  5. Junio C HamanoOct 15, 2021

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.