mtd: nand: improve comment on NAND_BBT_DYNAMIC_STRUCT

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=9eeff8243677b8bbfc17e8e606e965bb591a759d
Commit:     9eeff8243677b8bbfc17e8e606e965bb591a759d
Parent:     b4dc53e16ff00c0edba3d3219e216475e68951b3
Author:     Brian Norris <computersforpeace at gmail.com>
AuthorDate: Tue May 31 16:31:27 2011 -0700
Committer:  Artem Bityutskiy <artem.bityutskiy at intel.com>
CommitDate: Sun Sep 11 15:01:57 2011 +0300

    mtd: nand: improve comment on NAND_BBT_DYNAMIC_STRUCT
    
    In an attempt to improve the documentation of the BBT code, I am expanding
    the comments I left in commit:
        58373ff0afff4cc8ac40608872995f4d87eb72ec
        mtd: nand: more BB Detection refactoring and dynamic scan options
    
    Signed-off-by: Brian Norris <computersforpeace at gmail.com>
    Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy at nokia.com>
---
 include/linux/mtd/bbm.h |    6 +++++-
 1 files changed, 5 insertions(+), 1 deletions(-)

diff --git a/include/linux/mtd/bbm.h b/include/linux/mtd/bbm.h
index 57d6a8d..c4eec22 100644
--- a/include/linux/mtd/bbm.h
+++ b/include/linux/mtd/bbm.h
@@ -113,7 +113,11 @@ struct nand_bbt_descr {
 /* Do not store flash based bad block table in OOB area; store it in-band */
 #define NAND_BBT_NO_OOB		0x00040000
 
-/* The nand_bbt_descr was created dynamicaly and must be freed */
+/*
+ * Flag set by nand_create_default_bbt_descr(), marking that the nand_bbt_descr
+ * was allocated dynamicaly and must be freed in nand_release(). Has no meaning
+ * in nand_chip.bbt_options.
+ */
 #define NAND_BBT_DYNAMICSTRUCT	0x80000000
 
 /* The maximum number of blocks to scan for a bbt */