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

Re: [PATCH] gc: remove trailing dot from "gc.log" line

From
Junio C Hamano <gitster@pobox.com>
Date
Aug 31, 2021, 18:17 UTC
Message-ID
<xmqqpmtttr56.fsf@gitster.g>
In-Reply-To
<CAPig+cQ1V-sSZzrBwDWZYFEFJY-W8s1aq4igfhg9vPBNdLJusA@mail.gmail.com>
Eric Sunshine <sunshine@sunshineco.com> writes:
Show 29 quoted lines
> On Tue, Aug 31, 2021 at 10:37 AM Ævar Arnfjörð Bjarmason
> <avarab@gmail.com> wrote:
>> Remove the trailing dot from the warning we emit about gc.log. It's
>> common for various terminal UX's to allow the user to select "words",
>> and by including the trailing dot a user wanting to select the path to
>> gc.log will need to manually remove the trailing dot.
>>
>> Such a user would also probably need to adjust the path if it e.g. had
>> spaces in it, but this should address this very common case.
>>
>> Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
>> Suggested-by: Jan Judas <snugar.i@gmail.com>
>> ---
>> diff --git a/builtin/gc.c b/builtin/gc.c
>> @@ -502,7 +502,7 @@ static int report_last_gc_error(void)
>>                 warning(_("The last gc run reported the following. "
>>                                "Please correct the root cause\n"
>> -                              "and remove %s.\n"
>> +                              "and remove %s\n"
>
> Bikeshedding: Adding a colon after "remove" would give this a slightly
> more grammatically-correct feel:
>
>     Please correct the root cause
>     and remove: /path/to/repo/.git/gc.log
>
>>                                "Automatic cleanup will not be performed "
>>                                "until the file is removed.\n\n"
>>                                "%s"),
OK.
Show 7 quoted lines
> Even more bikeshedding:
>
>     Please correct the root cause and remove
>     /path/to/repo/.git/gc.log
>     to allow automatic cleanup to resume.
>
> or something.

I also found the line break before "and remove" strange, but I think that is because the "Please" is not at the beginning of the paragraph, but is a second sentence. Perhaps unfolding "and remove" would make the first line overly long?

THanks.
Previous: Eric SunshineNext: Eric Sunshine
Message 4 of 8 in “UX suggestion”
  1. Jan JudasAug 31, 2021
  2. gc: remove trailing dot from "gc.log" lineÆvar Arnfjörð Bjarmason, Aug 31, 2021
  3. Eric SunshineAug 31, 2021
  4. Junio C HamanoAug 31, 2021
  5. Eric SunshineAug 31, 2021
  6. Ævar Arnfjörð BjarmasonAug 31, 2021
  7. Eric SunshineSep 1, 2021
  8. Jan JudasSep 2, 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.