Commit b6d676db35ca6c99180bb12dcbd4a8c3b2995e49

Authored by Randy Dunlap
Committed by Linus Torvalds
1 parent 71740c423c

mtd/nand_base: fix kernel-doc warnings & typos

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 <randy.dunlap@oracle.com>
Cc: David Woodhouse <dwmw2@infradead.org>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>

Showing 2 changed files with 22 additions and 19 deletions Side-by-side Diff

drivers/mtd/nand/nand_base.c
... ... @@ -889,17 +889,17 @@
889 889 }
890 890  
891 891 /**
892   - * __nand_unlock - [REPLACABLE] unlocks specified locked blockes
  892 + * __nand_unlock - [REPLACEABLE] unlocks specified locked blocks
893 893 *
894   - * @param mtd - mtd info
895   - * @param ofs - offset to start unlock from
896   - * @param len - length to unlock
897   - * @invert - when = 0, unlock the range of blocks within the lower and
  894 + * @mtd: mtd info
  895 + * @ofs: offset to start unlock from
  896 + * @len: length to unlock
  897 + * @invert: when = 0, unlock the range of blocks within the lower and
898 898 * upper boundary address
899   - * whne = 1, unlock the range of blocks outside the boundaries
  899 + * when = 1, unlock the range of blocks outside the boundaries
900 900 * of the lower and upper boundary address
901 901 *
902   - * @return - unlock status
  902 + * return - unlock status
903 903 */
904 904 static int __nand_unlock(struct mtd_info *mtd, loff_t ofs,
905 905 uint64_t len, int invert)
906 906  
907 907  
... ... @@ -931,13 +931,13 @@
931 931 }
932 932  
933 933 /**
934   - * nand_unlock - [REPLACABLE] unlocks specified locked blockes
  934 + * nand_unlock - [REPLACEABLE] unlocks specified locked blocks
935 935 *
936   - * @param mtd - mtd info
937   - * @param ofs - offset to start unlock from
938   - * @param len - length to unlock
  936 + * @mtd: mtd info
  937 + * @ofs: offset to start unlock from
  938 + * @len: length to unlock
939 939 *
940   - * @return - unlock status
  940 + * return - unlock status
941 941 */
942 942 int nand_unlock(struct mtd_info *mtd, loff_t ofs, uint64_t len)
943 943 {
944 944  
945 945  
946 946  
... ... @@ -982,16 +982,16 @@
982 982 }
983 983  
984 984 /**
985   - * nand_lock - [REPLACABLE] locks all blockes present in the device
  985 + * nand_lock - [REPLACEABLE] locks all blocks present in the device
986 986 *
987   - * @param mtd - mtd info
988   - * @param ofs - offset to start unlock from
989   - * @param len - length to unlock
  987 + * @mtd: mtd info
  988 + * @ofs: offset to start unlock from
  989 + * @len: length to unlock
990 990 *
991   - * @return - lock status
  991 + * return - lock status
992 992 *
993   - * This feature is not support in many NAND parts. 'Micron' NAND parts
994   - * do have this feature, but it allows only to lock all blocks not for
  993 + * This feature is not supported in many NAND parts. 'Micron' NAND parts
  994 + * do have this feature, but it allows only to lock all blocks, not for
995 995 * specified range for block.
996 996 *
997 997 * Implementing 'lock' feature by making use of 'unlock', for now.
... ... @@ -2093,6 +2093,7 @@
2093 2093 * nand_fill_oob - [Internal] Transfer client buffer to oob
2094 2094 * @chip: nand chip structure
2095 2095 * @oob: oob data buffer
  2096 + * @len: oob data write length
2096 2097 * @ops: oob ops structure
2097 2098 */
2098 2099 static uint8_t *nand_fill_oob(struct nand_chip *chip, uint8_t *oob, size_t len,
... ... @@ -1454,6 +1454,8 @@
1454 1454 my $file = shift;
1455 1455  
1456 1456 $x =~ s@/\*.*?\*/@@gos; # strip comments.
  1457 + $x =~ s/^#\s*define\s+.*$//; # strip #define macros inside enums
  1458 +
1457 1459 if ($x =~ /enum\s+(\w+)\s*{(.*)}/) {
1458 1460 $declaration_name = $1;
1459 1461 my $members = $2;