Commit f66fcedc authored by Takashi Iwai's avatar Takashi Iwai
Browse files

ALSA: Document debug macros 



Add descriptions of snd_BUG() and snd_BUG_ON().
Also fixed a typo in the comment of snd_printk(), too.

Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 945eed02

include/sound/core.h

+23 −1
Original line number Diff line number Diff line
@@ -356,7 +356,7 @@ void snd_verbose_printd(const char *file, int line, const char *format, ...) 
 * snd_printk - printk wrapper

 * @fmt: format string

 *

 * Works like print() but prints the file and the line of the caller

 * Works like printk() but prints the file and the line of the caller

 * when configured with CONFIG_SND_VERBOSE_PRINTK.

 */

#define snd_printk(fmt, args...) \
@@ -383,7 +383,29 @@ void snd_verbose_printd(const char *file, int line, const char *format, ...) 
	printk(fmt ,##args)

#endif



/**

 * snd_BUG - give a BUG warning message and stack trace

 *

 * Calls WARN() if CONFIG_SND_DEBUG is set.

 * Ignored when CONFIG_SND_DEBUG is not set.

 */

#define snd_BUG()		WARN(1, "BUG?\n")



/**

 * snd_BUG_ON - debugging check macro

 * @cond: condition to evaluate

 *

 * When CONFIG_SND_DEBUG is set, this macro evaluates the given condition,

 * and call WARN() and returns the value if it's non-zero.

 * 

 * When CONFIG_SND_DEBUG is not set, this just returns zero, and the given

 * condition is ignored.

 *

 * NOTE: the argument won't be evaluated at all when CONFIG_SND_DEBUG=n.

 * Thus, don't put any statement that influences on the code behavior,

 * such as pre/post increment, to the argument of this macro.

 * If you want to evaluate and give a warning, use standard WARN_ON().

 */

#define snd_BUG_ON(cond)	WARN((cond), "BUG? (%s)\n", __stringify(cond))



#else /* !CONFIG_SND_DEBUG */