linux-toradex.git/Documentation/CodingStyle, branch v3.18-rc6

CodingStyle: fix a minor typo

2014-08-26T07:35:54+00:00

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:17+00:00

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:01+00:00

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:03+00:00

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:59+00:00

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:26+00:00

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:15+00:00

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:47+00:00

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

CodingStyle: Document the exception of not splitting user-visible strings, for grepping

2011-08-06T18:59:07+00:00

Patch reviewers now recommend not splitting long user-visible strings,
such as printk messages, even if they exceed 80 columns.  This avoids
breaking grep.  However, that recommendation did not actually appear
anywhere in Documentation/CodingStyle.

See, for example, the thread at
  http://news.gmane.org/find-root.php?message_id=%3c1312215262.11635.15.camel%40Joe%2dLaptop%3e

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

Documentation: update CodingStyle memory allocators

2011-07-06T20:17:51+00:00

The list of available general purpose memory allocators in
Documentation/CodingStyle chapter 14 is incomplete. This patch adds
the missing vzalloc() to the list.

Signed-off-by: Jesper Juhl 
Signed-off-by: Randy Dunlap 
Signed-off-by: Linus Torvalds