Update comments about use of CONFIG_YAFFS_9BYTE_TAGS option.

[yaffs2.git] / moduleconfig.h

diff --git a/moduleconfig.h b/moduleconfig.h
index 41fb3c5ac073803dab5595c3c1e4909215475205..faf135d02f653d9446464c89ce47dd91579582cf 100644 (file)
--- a/moduleconfig.h
+++ b/moduleconfig.h
@@ -1,3 +1,18 @@
+/*
+ * YAFFS: Yet another Flash File System . A NAND-flash specific file system. 
+ *
+ * Copyright (C) 2002-2007 Aleph One Ltd.
+ *   for Toby Churchill Ltd and Brightstar Engineering
+ *
+ * Created by Martin Fouts <Martin.Fouts@palmsource.com> 
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License version 2.1 as
+ * published by the Free Software Foundation.
+ *
+ * Note: Only YAFFS headers are LGPL, YAFFS C code is covered by GPL.
+ */
+
 #ifndef __YAFFS_CONFIG_H__
 #define __YAFFS_CONFIG_H__
 
@@ -29,7 +44,21 @@
 
 /* Default: 10 */
 /* Meaning: set the count of blocks to reserve for checkpointing */
-#define YAFFS_CHECKPOINT_RESERVED_BLOCKS 10
+#define CONFIG_YAFFS_CHECKPOINT_RESERVED_BLOCKS 10
+
+/*
+Older-style on-NAND data format has a "pageStatus" byte to record
+chunk/page state.  This byte is zeroed when the page is discarded.
+Choose this option if you have existing on-NAND data in this format
+that you need to continue to support.  New data written also uses the
+older-style format.
+Note: Use of this option generally requires that MTD's oob layout be
+adjusted to use the older-style format.  See notes on tags formats and
+MTD versions in yaffs_mtdif1.c.
+*/
+/* Default: Not selected */
+/* Meaning: Use older-style on-NAND data format with pageStatus byte */
+//#define CONFIG_YAFFS_9BYTE_TAGS
 
 #endif /* YAFFS_OUT_OF_TREE */