git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Oswald Buddenhagen <oswald.buddenhagen@gmx.de>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/3] Capitalization and punctuation fixes to some user visible messages
Date: Thu, 23 Mar 2023 13:39:28 -0700	[thread overview]
Message-ID: <xmqqttyb6w3j.fsf@gitster.g> (raw)
In-Reply-To: <20230323162234.995485-1-oswald.buddenhagen@gmx.de> (Oswald Buddenhagen's message of "Thu, 23 Mar 2023 17:22:32 +0100")

Oswald Buddenhagen <oswald.buddenhagen@gmx.de> writes:

>  			require_clean_work_tree(the_repository,
>  				N_("pull with rebase"),
> -				_("please commit or stash them."), 1, 0);
> +				_("Please commit or stash them."), 1, 0);

The require_clean_work_tree() function uses the message this patch
touches here like so:

	...
	if (err) {
		if (hint)
			error("%s", hint);
		if (!gently)
			exit(128);
	}

and the message given to error() is shown with "error: " prefix.
Our friendly CodingGuidelines is fairly clear on what to do to a
single sentence error message like this one:

| Error Messages
| 
|  - Do not end error messages with a full stop.
| 
|  - Do not capitalize the first word, only because it is the first word
|    in the message ("unable to open %s", not "Unable to open %s").  But
|    "SHA-3 not supported" is fine, because the reason the first word is
|    capitalized is not because it is at the beginning of the sentence,
|    but because the word would be spelled in capital letters even when
|    it appeared in the middle of the sentence.

So, if you want to touch this message, what you want to do is to
leave the capitalization alone, but to drop the full stop at the
end.

> diff --git a/sequencer.c b/sequencer.c
> index 3be23d7ca2..fda68cd33d 100644
> --- a/sequencer.c
> +++ b/sequencer.c
> @@ -3629,13 +3629,13 @@ static int do_exec(struct repository *r, const char *command_line)
>  			  "\n"),
>  			command_line,
>  			dirty ? N_("and made changes to the index and/or the "
> -				"working tree\n") : "");
> +				"working tree.\n") : "");

I think this long and multi-sentence warning message should be split
into two and the latter half should become an advice message that
the user can squelch.  Until it happens, which would require us to
rewrite these messages, I wouldn't bother touching this message if I
were you.

>  	} else if (dirty) {
>  		warning(_("execution succeeded: %s\nbut "
> -			  "left changes to the index and/or the working tree\n"
> +			  "left changes to the index and/or the working tree.\n"
>  			  "Commit or stash your changes, and then run\n"
>  			  "\n"
>  			  "  git rebase --continue\n"

Likewise.

  parent reply	other threads:[~2023-03-23 20:39 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-03-23 16:22 [PATCH 1/3] Capitalization and punctuation fixes to some user visible messages Oswald Buddenhagen
2023-03-23 16:22 ` [PATCH 2/3] sequencer: actually translate report in do_exec() Oswald Buddenhagen
2023-03-23 20:43   ` Junio C Hamano
2023-03-23 21:20     ` Oswald Buddenhagen
2023-03-23 21:25       ` Junio C Hamano
2023-03-23 21:53         ` Oswald Buddenhagen
2023-03-23 16:22 ` [PATCH 3/3] advice: translate all actions in error_resolve_conflict() Oswald Buddenhagen
2023-03-24 14:44   ` Junio C Hamano
2023-03-23 20:39 ` Junio C Hamano [this message]
2023-03-23 21:10   ` [PATCH 1/3] Capitalization and punctuation fixes to some user visible messages Oswald Buddenhagen
2023-04-28 12:56 ` [PATCH v2 1/3] advice: handle "rebase" in error_resolve_conflict() Oswald Buddenhagen
2023-04-28 12:56   ` [PATCH v2 2/3] sequencer: actually translate report in do_exec() Oswald Buddenhagen
2023-04-28 19:02     ` Junio C Hamano
2023-04-28 12:56   ` [PATCH v2 3/3] Capitalization and punctuation fixes to some user visible messages Oswald Buddenhagen
2023-04-28 18:57     ` Junio C Hamano
2023-04-28 19:09       ` Junio C Hamano
2023-04-28 19:01   ` [PATCH v2 1/3] advice: handle "rebase" in error_resolve_conflict() Junio C Hamano
2023-04-29  7:18     ` Oswald Buddenhagen
2023-04-30  5:06       ` Junio C Hamano
2023-08-07 17:09   ` [PATCH v3] " Oswald Buddenhagen
2023-08-07 20:20     ` Junio C Hamano

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=xmqqttyb6w3j.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=git@vger.kernel.org \
    --cc=oswald.buddenhagen@gmx.de \
    /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).