Re: [PATCH] printk-formats.txt documentation update

[Randy Dunlap <rdunlap@xenotime.net>]

On Thu, 09 Jun 2011 15:00:29 -0700 Joe Perches wrote:

> On Thu, 2011-06-09 at 14:51 -0700, Randy Dunlap wrote:
> > On Thu,  9 Jun 2011 22:24:48 +0100 Andrew Murray wrote:
> > > +	For printing-16 byte UUID/GUIDs addresses. The additional 'l', 'L',
> > 	For printing 16-byte
> > You want to resend or shall I just fix it?
> 
> Hey Randy.
> 
> I find your seeming insistence on using a dash
> between the numeric count and the word byte to
> be a bit odd.
> 
> Stylistically, why do you want it there?

Mostly to make it clear.  It's too easy to be ambiguous.


> cheers, Joe

Without hyphen:

	For printing 16 byte UUID/GUIDs addresses.

Those adjectives are confusing.  I don't know what that phrase means.
It could easily mean 16 UUID/GUIDs, but it's ambiguous.

But

	For printing 16-byte UUID/GUIDs addresses.

That means (clearly to me) that UUID/GUIDs are 16-byte entities.

Or see www.incredibleenglish.com/pdf/Hyphens.pdf, section 1,
"Hyphenate unit modifiers."

Or see http://www.ehow.com/how_4473498_use-hyphen-sentence.html, section 1,
"Link compound modifiers with hyphens."

Or see http://www.getitwriteonline.com/archive/040201HyphAdj.htm


HTH.
---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***