]> git.karo-electronics.de Git - karo-tx-linux.git/commit
Documentation: expand/clarify debug documentation
authorDan Streetman <ddstreet@ieee.org>
Thu, 22 May 2014 00:43:36 +0000 (10:43 +1000)
committerStephen Rothwell <sfr@canb.auug.org.au>
Thu, 22 May 2014 00:43:36 +0000 (10:43 +1000)
commit8ce2658fc31bb7e2d640254ab57fa82489268e3a
tree3aba8b3228fd78fc832299dc5111638f07d89cf4
parentb345d2a4ba9821e33479fb334c80b194da476481
Documentation: expand/clarify debug documentation

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 <ddstreet@ieee.org>
Cc: Joe Perches <joe@perches.com>
Cc: Fabian Frederick <fabf@skynet.be>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Documentation/CodingStyle
include/linux/printk.h