public inbox for linux-kernel@vger.kernel.org
 help / color / mirror / Atom feed
From: Jesper Juhl <jesper.juhl@gmail.com>
To: Andrew Morton <akpm@osdl.org>
Cc: Randy Dunlap <randy.dunlap@oracle.com>,
	"Neil Horman" <nhorman@tuxdriver.com>,
	"Benjamin Herrenschmidt" <benh@kernel.crashing.org>,
	kernel-janitors@lists.osdl.org, kjhall@us.ibm.com,
	maxk@qualcomm.com, linux-kernel@vger.kernel.org
Subject: Re: [KJ][PATCH] Correct misc_register return code handling in several drivers
Date: Thu, 2 Nov 2006 01:44:50 +0100	[thread overview]
Message-ID: <200611020144.51196.jesper.juhl@gmail.com> (raw)
In-Reply-To: <20061101162727.72f1183b.akpm@osdl.org>

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.
+
+
 
 		Appendix I: References
 




  reply	other threads:[~2006-11-02  0:43 UTC|newest]

Thread overview: 28+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-10-23 17:19 [KJ][PATCH] Correct misc_register return code handling in several drivers Neil Horman
2006-10-23 17:39 ` Alan Cox
2006-10-23 17:54   ` Neil Horman
2006-10-23 18:23     ` Kylene Jo Hall
2006-10-23 19:18     ` Alan Cox
2006-10-23 18:01 ` [KJ] [PATCH] " Dan Carpenter
2006-10-23 18:13   ` Neil Horman
2006-10-23 18:32     ` Dan Carpenter
2006-10-23 18:44       ` Neil Horman
2006-10-24  3:34 ` [KJ][PATCH] " Benjamin Herrenschmidt
2006-10-24 12:53   ` Neil Horman
2006-10-24 13:24     ` [KJ] [PATCH] " Matthew Wilcox
2006-10-24 15:07       ` Neil Horman
2006-10-24 22:42     ` [KJ][PATCH] " Benjamin Herrenschmidt
2006-10-25 13:17       ` Neil Horman
2006-11-01 13:56       ` Neil Horman
2006-11-01 23:55         ` Andrew Morton
2006-11-02 14:21           ` Neil Horman
2006-11-02  0:05         ` Jesper Juhl
2006-11-02  0:11           ` Randy Dunlap
2006-11-02  0:24             ` Jesper Juhl
2006-11-02  0:27             ` Andrew Morton
2006-11-02  0:44               ` Jesper Juhl [this message]
2006-11-02  1:12                 ` Randy Dunlap
2006-11-02  1:23                   ` Jesper Juhl
2006-11-02  1:22                     ` Randy Dunlap
2006-11-15  0:04                       ` Randy Dunlap
2006-11-15  9:05                         ` Jesper Juhl

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=200611020144.51196.jesper.juhl@gmail.com \
    --to=jesper.juhl@gmail.com \
    --cc=akpm@osdl.org \
    --cc=benh@kernel.crashing.org \
    --cc=kernel-janitors@lists.osdl.org \
    --cc=kjhall@us.ibm.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=maxk@qualcomm.com \
    --cc=nhorman@tuxdriver.com \
    --cc=randy.dunlap@oracle.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