git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Eric Sunshine <sunshine@sunshineco.com>
Cc: "Ævar Arnfjörð Bjarmason" <avarab@gmail.com>,
	"Git List" <git@vger.kernel.org>,
	"Jan Judas" <snugar.i@gmail.com>
Subject: Re: [PATCH] gc: remove trailing dot from "gc.log" line
Date: Tue, 31 Aug 2021 11:17:57 -0700	[thread overview]
Message-ID: <xmqqpmtttr56.fsf@gitster.g> (raw)
In-Reply-To: <CAPig+cQ1V-sSZzrBwDWZYFEFJY-W8s1aq4igfhg9vPBNdLJusA@mail.gmail.com> (Eric Sunshine's message of "Tue, 31 Aug 2021 12:15:04 -0400")

Eric Sunshine <sunshine@sunshineco.com> writes:

> 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.

> 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.

  reply	other threads:[~2021-08-31 18:18 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-08-31 13:46 UX suggestion Jan Judas
2021-08-31 14:37 ` [PATCH] gc: remove trailing dot from "gc.log" line Ævar Arnfjörð Bjarmason
2021-08-31 16:15   ` Eric Sunshine
2021-08-31 18:17     ` Junio C Hamano [this message]
2021-08-31 18:23       ` Eric Sunshine
2021-08-31 20:36         ` Ævar Arnfjörð Bjarmason
2021-09-01  2:10           ` Eric Sunshine
2021-09-02 17:27   ` Jan Judas

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: http://vger.kernel.org/majordomo-info.html

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqpmtttr56.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=avarab@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=snugar.i@gmail.com \
    --cc=sunshine@sunshineco.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).