mtd/fs/jffs3 debug.h,1.12,1.13

[Artem Bityuckiy]

Update of /home/cvs/mtd/fs/jffs3
In directory phoenix.infradead.org:/tmp/cvs-serv24974

Modified Files:
	debug.h 
Log Message:
Add more comments.


Index: debug.h
===================================================================
RCS file: /home/cvs/mtd/fs/jffs3/debug.h,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- debug.h	21 Dec 2004 15:56:13 -0000	1.12
+++ debug.h	21 Dec 2004 16:25:46 -0000	1.13
@@ -23,7 +23,19 @@
  */
 #define JFFS3_DBG_SANITY_CHECKS	1
 
-/* JFFS3 subsystems */
+/* 
+ * JFFS3 subsystems. Used in messaging to distinguish debugging messages
+ * from different parts of JFFS3 and to be able to enable/disable
+ * messages from different parts of JFFS3 when developing/debugging
+ * JFFS3.
+ * Another objective is to have standard output format with prefixed
+ * function name, etc. When developing, one may add something else
+ * (PID, etc).
+ * 
+ * If developing something one may define new subsystem with its own
+ * output as well as to split some of already existing, if it is
+ * cosiedered to be too large.
+ */
 #define JFFS3_DBG_OTHER		1	/* Not classified */
 #define JFFS3_DBG_SCAN		2	/* Flash scan */
 #define JFFS3_DBG_GC		3	/* Garbage Collector */
@@ -196,18 +208,30 @@
 #define DBG_BI(debug_level, args...)						\
 	JFFS3DBG_SUBSYSTEM(JFFS3_DBG_BI, debug_level, args)
 
+/* 
+ * Please, use this macro in case of critical error which makes JFFS3
+ * futher unworkable or when you use BUG().
+ */
 #define ERROR_MSG(args...)							\
 	do {									\
 		printk(KERN_ERR "[JFFS3] Error in %s(): ", __FUNCTION__);	\
 		printk(args);							\
 	} while(0)
 
+/* 
+ * Please, use this macro in case of errors which do not make JFFS3
+ * unworkable.
+ */
 #define WARNING_MSG(args...)							\
 	do {									\
 		printk(KERN_WARNING "[JFFS3] Warning in %s(): ", __FUNCTION__);	\
 		printk(args);							\
 	} while(0)
 
+/*
+ * Use this macro when you want to note something. Do not use too often
+ * in order not to put unneded garbage to the system log
+ */
 #define NOTICE_MSG(args...)							\
 	do {									\
 		printk(KERN_NOTICE "[JFFS3]: ");				\