Skip to content

Commit

Permalink
mtd/nand_base: fix kernel-doc warnings & typos
Browse files Browse the repository at this point in the history
Fix mtd/nand_base.c kernel-doc warnings and typos.

Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'mtd'
Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'ofs'
Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'len'
Warning(drivers/mtd/nand/nand_base.c:893): No description found for parameter 'invert'
Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'mtd'
Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'ofs'
Warning(drivers/mtd/nand/nand_base.c:930): No description found for parameter 'len'
Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'mtd'
Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'ofs'
Warning(drivers/mtd/nand/nand_base.c:987): No description found for parameter 'len'
Warning(drivers/mtd/nand/nand_base.c:2087): No description found for parameter 'len'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: David Woodhouse <[email protected]>
Signed-off-by: Andrew Morton <[email protected]>
Signed-off-by: Linus Torvalds <[email protected]>
  • Loading branch information
rddunlap authored and torvalds committed Aug 11, 2010
1 parent 71740c4 commit b6d676d
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 19 deletions.
39 changes: 20 additions & 19 deletions drivers/mtd/nand/nand_base.c
Original file line number Diff line number Diff line change
Expand Up @@ -889,17 +889,17 @@ static int nand_wait(struct mtd_info *mtd, struct nand_chip *chip)
}

/**
* __nand_unlock - [REPLACABLE] unlocks specified locked blockes
* __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
*
* @param mtd - mtd info
* @param ofs - offset to start unlock from
* @param len - length to unlock
* @invert - when = 0, unlock the range of blocks within the lower and
* @mtd: mtd info
* @ofs: offset to start unlock from
* @len: length to unlock
* @invert: when = 0, unlock the range of blocks within the lower and
* upper boundary address
* whne = 1, unlock the range of blocks outside the boundaries
* when = 1, unlock the range of blocks outside the boundaries
* of the lower and upper boundary address
*
* @return - unlock status
* return - unlock status
*/
static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
uint64_t len, int invert)
Expand Down Expand Up @@ -931,13 +931,13 @@ static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
}

/**
* nand_unlock - [REPLACABLE] unlocks specified locked blockes
* nand_unlock - [REPLACEABLE] unlocks specified locked blocks
*
* @param mtd - mtd info
* @param ofs - offset to start unlock from
* @param len - length to unlock
* @mtd: mtd info
* @ofs: offset to start unlock from
* @len: length to unlock
*
* @return - unlock status
* return - unlock status
*/
int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
{
Expand Down Expand Up @@ -982,16 +982,16 @@ int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
}

/**
* nand_lock - [REPLACABLE] locks all blockes present in the device
* nand_lock - [REPLACEABLE] locks all blocks present in the device
*
* @param mtd - mtd info
* @param ofs - offset to start unlock from
* @param len - length to unlock
* @mtd: mtd info
* @ofs: offset to start unlock from
* @len: length to unlock
*
* @return - lock status
* return - lock status
*
* This feature is not support in many NAND parts. 'Micron' NAND parts
* do have this feature, but it allows only to lock all blocks not for
* This feature is not supported in many NAND parts. 'Micron' NAND parts
* do have this feature, but it allows only to lock all blocks, not for
* specified range for block.
*
* Implementing 'lock' feature by making use of 'unlock', for now.
Expand Down Expand Up @@ -2093,6 +2093,7 @@ static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
* nand_fill_oob - [Internal] Transfer client buffer to oob
* @chip: nand chip structure
* @oob: oob data buffer
* @len: oob data write length
* @ops: oob ops structure
*/
static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob, size_t len,
Expand Down
2 changes: 2 additions & 0 deletions scripts/kernel-doc
Original file line number Diff line number Diff line change
Expand Up @@ -1454,6 +1454,8 @@ sub dump_enum($$) {
my $file = shift;

$x =~ s@/\*.*?\*/@@gos; # strip comments.
$x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums

if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
$declaration_name = $1;
my $members = $2;
Expand Down

0 comments on commit b6d676d

Please sign in to comment.