Patchwork [v3,6/6] mtd: nand: correct comment on nand_chip badblockbits

login
register
mail settings
Submitter Brian Norris
Date Jan. 9, 2012, 8:23 p.m.
Message ID <1326140612-26323-7-git-send-email-computersforpeace@gmail.com>
Download mbox | patch
Permalink /patch/135107/
State Accepted
Commit 661a08327d11bcc4cf649c5ae4bdf2db0a87b320
Headers show

Comments

Brian Norris - Jan. 9, 2012, 8:23 p.m.
The description for badblockbits is incorrect. I think someone just made
up a false description on the spot to satisfy some kerneldoc warning.

Signed-off-by: Brian Norris <computersforpeace@gmail.com>
---
 include/linux/mtd/nand.h |    5 +++--
 1 files changed, 3 insertions(+), 2 deletions(-)

Patch

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index 3547205..a7d8f2e 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -454,8 +454,9 @@  struct nand_buffers {
  *			will be copied to the appropriate nand_bbt_descr's.
  * @badblockpos:	[INTERN] position of the bad block marker in the oob
  *			area.
- * @badblockbits:	[INTERN] number of bits to left-shift the bad block
- *			number
+ * @badblockbits:	[INTERN] minimum number of set bits in a good block's
+ *			bad block marker position; i.e., BBM == 11110111b is
+ *			not bad when badblockbits == 7
  * @cellinfo:		[INTERN] MLC/multichip data from chip ident
  * @numchips:		[INTERN] number of physical chips
  * @chipsize:		[INTERN] the size of one chip for multichip arrays