Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

dev_vdbg() documentation

Update CodingStyle to talk about "-DDEBUG" message conventions and the
new "-DVERBOSE_DEBUG" convention.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

authored by

David Brownell and committed by
Greg Kroah-Hartman
6b09448a aebdc3b4

+18 -2
+18 -2
Documentation/CodingStyle
··· 633 633 634 634 Kernel developers like to be seen as literate. Do mind the spelling 635 635 of kernel messages to make a good impression. Do not use crippled 636 - words like "dont" and use "do not" or "don't" instead. 636 + words like "dont"; use "do not" or "don't" instead. Make the messages 637 + concise, clear, and unambiguous. 637 638 638 639 Kernel messages do not have to be terminated with a period. 639 640 640 641 Printing numbers in parentheses (%d) adds no value and should be avoided. 642 + 643 + There are a number of driver model diagnostic macros in <linux/device.h> 644 + which you should use to make sure messages are matched to the right device 645 + and driver, and are tagged with the right level: dev_err(), dev_warn(), 646 + dev_info(), and so forth. For messages that aren't associated with a 647 + particular device, <linux/kernel.h> defines pr_debug() and pr_info(). 648 + 649 + Coming up with good debugging messages can be quite a challenge; and once 650 + you have them, they can be a huge help for remote troubleshooting. Such 651 + messages should be compiled out when the DEBUG symbol is not defined (that 652 + is, by default they are not included). When you use dev_dbg() or pr_debug(), 653 + that's automatic. Many subsystems have Kconfig options to turn on -DDEBUG. 654 + A related convention uses VERBOSE_DEBUG to add dev_vdbg() messages to the 655 + ones already enabled by DEBUG. 641 656 642 657 643 658 Chapter 14: Allocating memory ··· 805 790 http://www.kroah.com/linux/talks/ols_2002_kernel_codingstyle_talk/html/ 806 791 807 792 -- 808 - Last updated on 2006-December-06. 793 + Last updated on 2007-July-13. 794 +