mtd: nand: reword nand_chip bad block interface comments

[Linux-MTD Mailing List]

Gitweb:     http://git.infradead.org/?p=mtd-2.6.git;a=commit;h=ce157510eb886feb996a7a13354973bdf4aae1a1
Commit:     ce157510eb886feb996a7a13354973bdf4aae1a1
Parent:     caddab0f5b7563db72640e6c6a21fd7076418f36
Author:     Brian Norris <computersforpeace at gmail.com>
AuthorDate: Thu Apr 11 01:34:59 2013 -0700
Committer:  David Woodhouse <David.Woodhouse at intel.com>
CommitDate: Mon Aug 5 20:44:16 2013 +0100

    mtd: nand: reword nand_chip bad block interface comments
    
    This remedies a few problems:
    
    (1) The use of "the" vs. "a" is a little confusing, IMO.
    
    (2) nand_chip.block_bad is used exclusively for checking the OOB bad
        block markers of a NAND. Any BBT functionality is handled in
        nand_bbt.c, so this description should differentiate itself from
        nand_bbt.c.
    
    Signed-off-by: Brian Norris <computersforpeace at gmail.com>
    Signed-off-by: Artem Bityutskiy <artem.bityutskiy at linux.intel.com>
    Signed-off-by: David Woodhouse <David.Woodhouse at intel.com>
---
 include/linux/mtd/nand.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h
index ab63634..50c5ea0 100644
--- a/include/linux/mtd/nand.h
+++ b/include/linux/mtd/nand.h
@@ -390,8 +390,8 @@ struct nand_buffers {
  * @write_buf:		[REPLACEABLE] write data from the buffer to the chip
  * @read_buf:		[REPLACEABLE] read data from the chip into the buffer
  * @select_chip:	[REPLACEABLE] select chip nr
- * @block_bad:		[REPLACEABLE] check, if the block is bad
- * @block_markbad:	[REPLACEABLE] mark the block bad
+ * @block_bad:		[REPLACEABLE] check if a block is bad, using OOB markers
+ * @block_markbad:	[REPLACEABLE] mark a block bad
  * @cmd_ctrl:		[BOARDSPECIFIC] hardwarespecific function for controlling
  *			ALE/CLE/nCE. Also used to write command and address
  * @init_size:		[BOARDSPECIFIC] hardwarespecific function for setting