diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-13 06:40:36 -0400 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2017-05-16 07:44:18 -0400 |
commit | b6f6c29454d236e85f2912cb0f9366825ca1b0be (patch) | |
tree | 305831eb1b12910134573fa57a2bc9225b085f7a | |
parent | f341afe2fca77fbb258007dc9addb36784b4f252 (diff) |
mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings
./drivers/mtd/nand/nand_bbt.c:1: warning: no structured comments found
./include/linux/mtd/nand.h:785: ERROR: Unexpected indentation.
./drivers/mtd/nand/nand_base.c:449: WARNING: Definition list ends without a blank line; unexpected unindent.
./drivers/mtd/nand/nand_base.c:1161: ERROR: Unexpected indentation.
./drivers/mtd/nand/nand_base.c:1162: WARNING: Block quote ends without a blank line; unexpected unindent.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
-rw-r--r-- | Documentation/driver-api/mtdnand.rst | 3 | ||||
-rw-r--r-- | drivers/mtd/nand/nand_base.c | 7 | ||||
-rw-r--r-- | include/linux/mtd/nand.h | 2 |
3 files changed, 6 insertions, 6 deletions
diff --git a/Documentation/driver-api/mtdnand.rst b/Documentation/driver-api/mtdnand.rst index 7c19795ebb4a..e9afa586d15e 100644 --- a/Documentation/driver-api/mtdnand.rst +++ b/Documentation/driver-api/mtdnand.rst | |||
@@ -970,9 +970,6 @@ hints" for an explanation. | |||
970 | .. kernel-doc:: drivers/mtd/nand/nand_base.c | 970 | .. kernel-doc:: drivers/mtd/nand/nand_base.c |
971 | :export: | 971 | :export: |
972 | 972 | ||
973 | .. kernel-doc:: drivers/mtd/nand/nand_bbt.c | ||
974 | :export: | ||
975 | |||
976 | .. kernel-doc:: drivers/mtd/nand/nand_ecc.c | 973 | .. kernel-doc:: drivers/mtd/nand/nand_ecc.c |
977 | :export: | 974 | :export: |
978 | 975 | ||
diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c index b0524f8accb6..c8988c01e0d7 100644 --- a/drivers/mtd/nand/nand_base.c +++ b/drivers/mtd/nand/nand_base.c | |||
@@ -442,10 +442,12 @@ static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs) | |||
442 | * specify how to write bad block markers to OOB (chip->block_markbad). | 442 | * specify how to write bad block markers to OOB (chip->block_markbad). |
443 | * | 443 | * |
444 | * We try operations in the following order: | 444 | * We try operations in the following order: |
445 | * | ||
445 | * (1) erase the affected block, to allow OOB marker to be written cleanly | 446 | * (1) erase the affected block, to allow OOB marker to be written cleanly |
446 | * (2) write bad block marker to OOB area of affected block (unless flag | 447 | * (2) write bad block marker to OOB area of affected block (unless flag |
447 | * NAND_BBT_NO_OOB_BBM is present) | 448 | * NAND_BBT_NO_OOB_BBM is present) |
448 | * (3) update the BBT | 449 | * (3) update the BBT |
450 | * | ||
449 | * Note that we retain the first error encountered in (2) or (3), finish the | 451 | * Note that we retain the first error encountered in (2) or (3), finish the |
450 | * procedures, and dump the error in the end. | 452 | * procedures, and dump the error in the end. |
451 | */ | 453 | */ |
@@ -1155,9 +1157,10 @@ int nand_reset(struct nand_chip *chip, int chipnr) | |||
1155 | * @mtd: mtd info | 1157 | * @mtd: mtd info |
1156 | * @ofs: offset to start unlock from | 1158 | * @ofs: offset to start unlock from |
1157 | * @len: length to unlock | 1159 | * @len: length to unlock |
1158 | * @invert: when = 0, unlock the range of blocks within the lower and | 1160 | * @invert: |
1161 | * - when = 0, unlock the range of blocks within the lower and | ||
1159 | * upper boundary address | 1162 | * upper boundary address |
1160 | * when = 1, unlock the range of blocks outside the boundaries | 1163 | * - when = 1, unlock the range of blocks outside the boundaries |
1161 | * of the lower and upper boundary address | 1164 | * of the lower and upper boundary address |
1162 | * | 1165 | * |
1163 | * Returs unlock status. | 1166 | * Returs unlock status. |
diff --git a/include/linux/mtd/nand.h b/include/linux/mtd/nand.h index 9591e0fbe5bd..3d5b20379ba3 100644 --- a/include/linux/mtd/nand.h +++ b/include/linux/mtd/nand.h | |||
@@ -779,7 +779,7 @@ nand_get_sdr_timings(const struct nand_data_interface *conf) | |||
779 | * Minimum amount of bit errors per @ecc_step_ds guaranteed | 779 | * Minimum amount of bit errors per @ecc_step_ds guaranteed |
780 | * to be correctable. If unknown, set to zero. | 780 | * to be correctable. If unknown, set to zero. |
781 | * @ecc_step_ds: [INTERN] ECC step required by the @ecc_strength_ds, | 781 | * @ecc_step_ds: [INTERN] ECC step required by the @ecc_strength_ds, |
782 | * also from the datasheet. It is the recommended ECC step | 782 | * also from the datasheet. It is the recommended ECC step |
783 | * size, if known; if unknown, set to zero. | 783 | * size, if known; if unknown, set to zero. |
784 | * @onfi_timing_mode_default: [INTERN] default ONFI timing mode. This field is | 784 | * @onfi_timing_mode_default: [INTERN] default ONFI timing mode. This field is |
785 | * set to the actually used ONFI mode if the chip is | 785 | * set to the actually used ONFI mode if the chip is |