From: Junio C Hamano <gitster@pobox.com>
To: Vincent van Ravesteijn <vfr@lyx.org>
Cc: git@vger.kernel.org
Subject: Re: [PATCH 1/2] Unification of user message strings
Date: Mon, 19 Mar 2012 12:39:28 -0700 [thread overview]
Message-ID: <7v1uoobcsv.fsf@alter.siamese.dyndns.org> (raw)
In-Reply-To: <1332179503-2992-2-git-send-email-vfr@lyx.org> (Vincent van Ravesteijn's message of "Mon, 19 Mar 2012 18:51:42 +0100")
Vincent van Ravesteijn <vfr@lyx.org> writes:
> From: Vincent van Ravesteijn <vfr@lyx.org>
>
> Rewrite user messages to stick to a uniform style for all messages. From the surrounding code, the following guidelines were deduced:
> - messages start with a capital,
> - short messages do not end with a full stop,
> - paths, filenames, and commands are quoted by single quotes (if not separated by the normal text by a ':'),
> - 'could not' is used rather than 'cannot'.
>
> Signed-off-by: Vincent van Ravesteijn <vfr@lyx.org>
> ---
> gpg-interface.c | 6 +++---
> grep.c | 2 +-
> help.c | 2 +-
> sequencer.c | 24 ++++++++++++------------
> 4 files changed, 17 insertions(+), 17 deletions(-)
>
> diff --git a/gpg-interface.c b/gpg-interface.c
> index 09ab64a..5e14a21 100644
> --- a/gpg-interface.c
> +++ b/gpg-interface.c
> @@ -56,7 +56,7 @@ int sign_buffer(struct strbuf *buffer, struct strbuf *signature, const char *sig
> args[3] = NULL;
>
> if (start_command(&gpg))
> - return error(_("could not run gpg."));
> + return error(_("Could not run 'gpg'"));
Ok with s/c/C/, but I am not sure about the 'gpg' bit. The name of the
program and path to it can be configured so the user may be expecting to
run a program called gnupg, and unquoted gpg feels more like a generic
term to refer to the program. It might be worth using all-CAPS, though.
Likewise for the other hunks for this file.
> - return error(_("cannot open %s: %s"), filename,
> + return error(_("Could not open '%s': %s"), filename,
Honestly speaking, I would personally prefer "Cannot open" over "Could not
open". Yes, all the error messages report _after_ we attempted to do
something and finding that we _couldn't_ do that thing, so "Could not" may
be technically more correct, but still...
But that is probably just me.
Other than that, the patch looks good; let's hear from others, too.
next prev parent reply other threads:[~2012-03-19 19:39 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-03-19 17:51 [PATCH 0/2] Unify the style of user messages Vincent van Ravesteijn
2012-03-19 17:51 ` [PATCH 1/2] Unification of user message strings Vincent van Ravesteijn
2012-03-19 19:39 ` Junio C Hamano [this message]
2012-03-19 20:16 ` Vincent van Ravesteijn
2012-03-19 20:53 ` Jeff King
2012-03-19 21:36 ` Junio C Hamano
2012-03-20 7:47 ` Vincent van Ravesteijn
2012-03-20 12:01 ` Jakub Narebski
2012-03-20 12:33 ` Vincent van Ravesteijn
2012-03-19 17:51 ` [PATCH 2/2] Make some strings translatable Vincent van Ravesteijn
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7v1uoobcsv.fsf@alter.siamese.dyndns.org \
--to=gitster@pobox.com \
--cc=git@vger.kernel.org \
--cc=vfr@lyx.org \
/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.
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 NNTP newsgroup(s).