mtd: fix nand kernel-doc warnings

Linux-MTD Mailing List linux-mtd at lists.infradead.org
Fri Dec 3 11:59:04 EST 2010


Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=1534b8b09757190ce6e97fa97f9ad77c49082cd8
Commit:     1534b8b09757190ce6e97fa97f9ad77c49082cd8
Parent:     cc31822250236ec173bb2aa149ebe2ba35405db2
Author:     Randy Dunlap <randy.dunlap at oracle.com>
AuthorDate: Thu Nov 18 15:02:21 2010 -0800
Committer:  David Woodhouse <David.Woodhouse at intel.com>
CommitDate: Fri Dec 3 16:31:24 2010 +0000

    mtd: fix nand kernel-doc warnings
    
    Warning(include/linux/mtd/nand.h:543): No description found for parameter 'badblockbits'
    Warning(drivers/mtd/nand/nand_bbt.c:1101): No description found for parameter 'mtd'
    
    Signed-off-by: Randy Dunlap <randy.dunlap at oracle.com>
    Cc:	David Woodhouse <dwmw2 at infradead.org>
    Cc:	linux-mtd at lists.infradead.org
    Signed-off-by: Artem Bityutskiy <Artem.Bityutskiy at nokia.com>
    Signed-off-by: David Woodhouse <David.Woodhouse at intel.com>
---
 drivers/mtd/nand/nand_bbt.c |    3 ++-
 include/linux/mtd/nand.h    |    2 ++
 2 files changed, 4 insertions(+), 1 deletions(-)

diff --git a/drivers/mtd/nand/nand_bbt.c b/drivers/mtd/nand/nand_bbt.c
index 586b981..6ebd869 100644
--- a/drivers/mtd/nand/nand_bbt.c
+++ b/drivers/mtd/nand/nand_bbt.c
@@ -1092,7 +1092,8 @@ static void mark_bbt_region(struct mtd_info *mtd, struct nand_bbt_descr *td)
 
 /**
  * verify_bbt_descr - verify the bad block description
- * @bd:			the table to verify
+ * @mtd:	MTD device structure
+ * @bd:		the table to verify
  *
  * This functions performs a few sanity checks on the bad block description
  * table.
diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 63e17d0..1f489b2 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -448,6 +448,8 @@ struct nand_buffers {
  *			See the defines for further explanation.
  * @badblockpos:	[INTERN] position of the bad block marker in the oob
  *			area.
+ * @badblockbits:	[INTERN] number of bits to left-shift the bad block
+ *			number
  * @cellinfo:		[INTERN] MLC/multichip data from chip ident
  * @numchips:		[INTERN] number of physical chips
  * @chipsize:		[INTERN] the size of one chip for multichip arrays



More information about the linux-mtd-cvs mailing list