From: Andrew Cagney <ac131313@cygnus.com>
To: gdb@sources.redhat.com
Subject: how to format an error?
Date: Sun, 13 Jan 2002 20:36:00 -0000 [thread overview]
Message-ID: <3C426042.8050807@cygnus.com> (raw)
[-- Attachment #1: Type: text/plain, Size: 283 bytes --]
(no one commented last time, I'll try again).
Given the attached, which is the correct way of formatting an error message:
This is an error message.
this is an error message.
This is an error message
this is an error message
GDB (no suprize) does all of the above :-)
Andrew
[-- Attachment #2: [Fwd: [PATCH] Various source cleanup/enhancements] --]
[-- Type: message/rfc822, Size: 6537 bytes --]
[-- Attachment #2.1.1: Type: text/plain, Size: 110 bytes --]
What is the correct format of an error message string? The attached,
from binutils is interesting.
Andrew
[-- Attachment #2.1.2: Re: [PATCH] Various source cleanup/enhancements --]
[-- Type: message/rfc822, Size: 3930 bytes --]
From: Alan Modra <amodra@bigpond.net.au>
To: Eric Christopher <echristo@redhat.com>
Cc: Thiemo Seufer <ica2_ts@csv.ica.uni-stuttgart.de>, binutils@sources.redhat.com
Subject: Re: [PATCH] Various source cleanup/enhancements
Date: Tue, 4 Dec 2001 09:04:24 +1030
Message-ID: <20011204090424.O1047@bubble.sa.bigpond.net.au>
On Mon, Dec 03, 2001 at 01:59:46PM -0800, Eric Christopher wrote:
> On Mon, 2001-12-03 at 13:57, Alan Modra wrote:
> > On Mon, Dec 03, 2001 at 01:47:04PM -0800, Eric Christopher wrote:
> > > Ok except for these. Make sure they are capitals before checking in :)
> >
> > Err, the standard (from gcc) for error messages is as Thiemo had it.
> > This text is prefixed with "Error: " so it doesn't start a sentence, and
> > thus should not start with a capital.
>
> Ah ha. Thanks :)
BTW, I'm not too sure about the rationale I gave regarding not starting
a sentence. That opinion was just parroted from someone on the gcc list.
I'd say the text following the colon _is_ the start of a new sentence,
but I don't want to get into grammar wars. :)
http://www.gnu.org/prep/standards_15.html#SEC15 says
"The string message should not begin with a capital letter when it follows
a program name and/or file name. Also, it should not end with a period.
Error messages from interactive programs, and other messages such as usage
messages, should start with a capital letter. But they should not end
with a period."
next reply other threads:[~2002-01-14 4:36 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2002-01-13 20:36 Andrew Cagney [this message]
2002-01-14 0:22 ` Eli Zaretskii
2002-01-14 2:37 ` Richard Earnshaw
2002-01-14 3:08 ` Eli Zaretskii
2002-02-02 8:09 ` Andrew Cagney
2002-02-02 9:27 ` Eli Zaretskii
2002-02-03 19:22 ` Andrew Cagney
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=3C426042.8050807@cygnus.com \
--to=ac131313@cygnus.com \
--cc=gdb@sources.redhat.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.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox