From: Simon Glass <sjg@chromium.org>
Date: Mon, 20 Jun 2016 01:43:03 +0000 (-0600)
Subject: Add comments for debug() and pr_fmt
X-Git-Tag: KARO-TXSD-2017-03-15~561
X-Git-Url: https://git.karo-electronics.de/?a=commitdiff_plain;h=5e7f74332465f0addc05634d351df8eeaa2015d2;p=karo-tx-uboot.git

Add comments for debug() and pr_fmt

Add a note to each of these so it is more obvious how they work.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

diff --git a/include/common.h b/include/common.h
index 3feaae641c..1bb8a7956b 100644
--- a/include/common.h
+++ b/include/common.h
@@ -101,6 +101,7 @@ typedef volatile unsigned char	vu_char;
 #define _DEBUG	0
 #endif
 
+/* Define this at the top of a file to add a prefix to debug messages */
 #ifndef pr_fmt
 #define pr_fmt(fmt) fmt
 #endif
@@ -116,6 +117,7 @@ typedef volatile unsigned char	vu_char;
 			printf(pr_fmt(fmt), ##args);	\
 	} while (0)
 
+/* Show a message if DEBUG is defined in a file */
 #define debug(fmt, args...)			\
 	debug_cond(_DEBUG, fmt, ##args)