This is the mail archive of the mailing list for the GDB project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

how to format an error?

(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 :-)

--- Begin Message ---
What is the correct format of an error message string?  The attached, 
from binutils is interesting.

--- Begin Message ---
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.  :) 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."

--- End Message ---
--- End Message ---

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]