Re: [KJ][PATCH] Correct misc_register return code handling in several drivers

[Randy Dunlap <randy.dunlap@oracle.com>]

Jesper Juhl wrote:
> On Thursday 02 November 2006 01:27, Andrew Morton wrote:
> > On Wed, 1 Nov 2006 16:11:55 -0800
> > Randy Dunlap <randy.dunlap@oracle.com> wrote:
> >
> > > > Hmm, I guess that should be defined once and for all in
> > > > Documentation/CodingStyle
> > > I have some other CodingStyle changes to submit, but feel free
> > > to write this one up.
> > Starting labels in column 2 gives me the creeps, personally.  But there's a
> > decent justification for it.
> >
> > > However, I didn't know that we had a known style for this, other
> > > than "not indented so far that it's hidden".
> > >
> > > If a label in column 0 [0-based :] confuses patch, then that's
> > > a reason, I suppose.  I wasn't aware of that one...
> > > In a case like that, we usually say "fix the tool then."
> > The problem is that `diff -p' screws up and displays the label: in the
> > place where it should be displaying the function name.
> >
> > Of course, lots of people forget the -p anyway...  Maybe we can fix those
> > tools ;)
> Until the tools get fixed, how about applying this patch ?
>
>
> Add CodngStyle info on labels.
>
> Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
> ---
>
> diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle
> index 29c1896..f8a3abb 100644
> --- a/Documentation/CodingStyle
> +++ b/Documentation/CodingStyle
> @@ -566,6 +566,18 @@ result.  Typical examples would be funct
>  NULL or the ERR_PTR mechanism to report failure.
>  
>  
> +		Chapter 17: Labels
> +
> +Label names should be lowercase.
> +
> +Label names should start with a letter [a-z].
> +
> +Labels should not be placed at column 0. Doing so confuses some tools, most
> +notably 'diff' and 'patch'. Instead place labels at column 1 (indented 1
> +space). In some cases it's OK to indent labels one or more tabs, but
> +generally it is prefered that labels be placed at column 1.
		~~~~~~~~~~~~
		preferred

I would also say something like this:

Labels should stand out -- be easily visible.  They should not be
indented so much that they are hidden or obscured by the surrounding
source code.



--
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/