linux/Documentation/CodingStyle, branch v3.19

CodingStyle: add some more error handling guidelines

2014-12-02T13:55:32Z

I added a paragraph on choosing label names, and updated the example code to use a better label name. I also cleaned up the example code to more modern style by moving the allocation out of the initializer and changing the NULL check. Perhaps the most common type of error handling bug in the kernel is "one err bugs". CodingStyle already says that we should "avoid nesting" by using error labels and one err style error handling tends to have multiple indent levels, so this was already bad style. But I've added a new paragraph explaining how to avoid one err bugs by using multiple error labels which is, hopefully, more clear. Signed-off-by: Dan Carpenter Acked-by: Julia Lawall [jc: added GFP_KERNEL to kmalloc() call] Signed-off-by: Jonathan Corbet

CodingStyle: Add a chapter on conditional compilation

2014-11-03T16:46:02Z

Document several common practices and conventions regarding conditional compilation, most notably the preference for ifdefs in headers rather than .c files. Signed-off-by: Josh Triplett Acked-by: Geert Uytterhoeven Signed-off-by: Jonathan Corbet

CodingStyle: fix a minor typo

2014-08-26T07:35:54Z

There was a minor typo in the CodingStyle document where the word 'section' had been spelled as 'secton'. Signed-off-by: Raymond L. Rivera Signed-off-by: Jiri Kosina

Documentation: expand/clarify debug documentation

2014-06-04T23:54:17Z

The pr_debug() and related debug print macros all differ from the normal pr_XXX() macros, in that the normal ones print unconditionally, while the debug macros are compiled out unless DEBUG is defined or CONFIG_DYNAMIC_DEBUG is set. This isn't obvious, and the only way to find this out is either to review the actual printk.h code or to read CodingStyle, and the message there doesn't highlight the fact. Change Documentation/CodingStyle to clearly indicate that pr_debug() and related debug printing macros behave differently than all other pr_XXX() macros, and attempt to clarify when and where the different debug printing methods might be used. Add short comment to printk.h above the pr_XXX() macros indicating that while these macros print unconditionally, pr_debug() does not. Signed-off-by: Dan Streetman Cc: Joe Perches Cc: Fabian Frederick Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds

Documentation/CodingStyle: allow multiple return statements per function

2013-07-03T23:08:01Z

A surprising number of newbies interpret this section to mean that only one return statement is allowed per function. Part of the problem is that the "one return statement per function" rule is an actual style guideline that people are used to from other projects. Signed-off-by: Dan Carpenter Cc: Eduardo Valentin Cc: Rob Landley Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds

Documentation: remove depends on CONFIG_EXPERIMENTAL

2013-01-11T19:38:03Z

The CONFIG_EXPERIMENTAL config item has not carried much meaning for a while now and is almost always enabled by default. As agreed during the Linux kernel summit, remove it from any "depends on" lines in Kconfigs. CC: Rob Landley CC: Jiri Kosina CC: Masanari Iida CC: Jason Wessel CC: Richard L Maliszewski CC: Gang Wei CC: Shane Wang CC: Harry Wei Signed-off-by: Kees Cook Acked-by: Jason Wessel

CodingStyle: add networking specific block comment style

2012-10-05T18:04:59Z

The block comment style in net/ and drivers/net is non-standard. Document it. Signed-off-by: Joe Perches Cc: "Allan, Bruce W" Cc: Andy Whitcroft Cc: David Miller Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds

CodingStyle: add kmalloc_array() to memory allocators

2012-06-01T00:49:26Z

Add the new kmalloc_array() to the list of general-purpose memory allocators in chapter 14. Signed-off-by: Xi Wang Acked-by: Jesper Juhl Acked-by: Pekka Enberg Signed-off-by: Andrew Morton Signed-off-by: Linus Torvalds

Documentation: CodingStyle: add inline assembly guidelines

2012-03-30T23:03:15Z

Signed-off-by: Josh Triplett Signed-off-by: Randy Dunlap Signed-off-by: Linus Torvalds

Documentation: update CodingStyle use of braces

2011-11-04T19:01:47Z

After commit 38829dc9d7b4 ("Documentation/CodingStyle: flesh out if-else examples") highlight that if _only_one_ branch of a conditional statement is a single statement, then braces are to be used on both branches. Signed-off-by: Antonio Ospite Signed-off-by: Randy Dunlap Signed-off-by: Linus Torvalds