Messages in this thread Patch in this message | | | Date | Tue, 5 Sep 2006 10:08:14 +0200 | From | Pavel Machek <> | Subject | Re: CodingStyle (was: Re: sound/pci/hda/intel_hda: small cleanups) |
| |
Hi!
> > > So, just this morning I have seen questions and opinions about > > > the following that could (or could not) use more documentation > > > or codification and I'm sure that we could easily find more, > > > but do we want to codify Everything?? > > > > > > > > > 1. Kconfig help text should be indented (it's not indented in the > > > GFS2 patches)
Chapter 10 speaks about that alread?
Chapter 10: Configuration-files
For configuration options (arch/xxx/Kconfig, and all the Kconfig files), somewhat different indentation is used.
Help text is indented with 2 spaces.
if CONFIG_EXPERIMENTAL tristate CONFIG_BOOM default n help Apply nitroglycerine inside the keyboard (DANGEROUS) bool CONFIG_CHEER depends on CONFIG_BOOM default y help Output nice messages when you explode endif
> > > 2. if (!condition1) /* no space between ! and condition1 */ > > > 3. don't use C99-style // comments > > > 4. unsigned int bitfield :<nr_bits>;
Ok.
> > Looks reasonable to me. Will you do the patch or should I ? > > Please (you) go ahead with it.
Does it look okay?
Signed-off-by: Pavel Machek <pavel@suse.cz>
diff --git a/Documentation/CodingStyle b/Documentation/CodingStyle index 6d2412e..d8e51a6 100644 --- a/Documentation/CodingStyle +++ b/Documentation/CodingStyle @@ -46,6 +46,16 @@ used for indentation, and the above exam Get a decent editor and don't leave whitespace at the end of lines. +Bitfield variables should be indented like this: + + unsigned int foo :1; + +Avoid extra spaces around ! operator, and do not place spaces around (s. + + if (!buffer) + +is okay, if ( ! buffer ) is just ugly. + Chapter 2: Breaking long lines and strings @@ -280,7 +290,7 @@ int fun(int a) int result = 0; char *buffer = kmalloc(SIZE); - if (buffer == NULL) + if (!buffer) return -ENOMEM; if (condition1) { @@ -316,6 +326,9 @@ When commenting the kernel API functions See the files Documentation/kernel-doc-nano-HOWTO.txt and scripts/kernel-doc for details. +Please do not use C99-style comments, and do not use comments to +comment out unused code. + Chapter 9: You've made a mess of it That's OK, we all do. You've probably been told by your long-time Unix -- (english) http://www.livejournal.com/~pavelmachek (cesky, pictures) http://atrey.karlin.mff.cuni.cz/~pavel/picture/horses/blog.html - 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/
| |