Added some documentation to moduleconfig.h and set it to match the

[yaffs2.git] / moduleconfig.h

diff --git a/moduleconfig.h b/moduleconfig.h
index 2809701f79775e9737ddab54a21f11d87353461b..e67c7bc8029559885b9c9e904e06eb09bdc691c8 100644 (file)
--- a/moduleconfig.h
+++ b/moduleconfig.h
@@ -2,13 +2,31 @@
 #define __YAFFS_CONFIG_H__
 
 #ifdef YAFFS_OUT_OF_TREE
+
+/* DO NOT UNSET THESE THREE. YAFFS2 will not compile if you do. */
 #define CONFIG_YAFFS_FS
 #define CONFIG_YAFFS_YAFFS1
 #define CONFIG_YAFFS_YAFFS2
-#define CONFIG_YAFFS_DOES_ECC
-#define CONFIG_YAFFS_ECC_WRONG_ORDER
+
+/* These options are independent of each other.  Select those that matter. */
+
+/* Default: Not selected */
+/* Meaning: Yaffs does its own ECC, rather than using MTD ECC */
+//#define CONFIG_YAFFS_DOES_ECC
+
+/* Default: Not selected */
+/* Meaning: ECC byte order is 'wrong'.  Only meaningful if */
+/*          CONFIG_YAFFS_DOES_ECC is set */
+//#define CONFIG_YAFFS_ECC_WRONG_ORDER
+
+/* Default: Selected */
+/* Meaning: Disables testing whether chunks are erased before writing to them*/
 #define CONFIG_YAFFS_DISABLE_CHUNK_ERASED_CHECK
+
+/* Default: Selected */
+/* Meaning: Cache short names, taking more RAM, but faster look-ups */
 #define CONFIG_YAFFS_SHORT_NAMES_IN_RAM
-#endif /* KBUILD_MODNAME */
+
+#endif /* YAFFS_OUT_OF_TREE */
 
 #endif /* __YAFFS_CONFIG_H__ */