Kernel/linux
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git synced 2025-01-12 08:09:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings

Browse Source 
./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>
This commit is contained in:
Mauro Carvalho Chehab 2017-05-13 07:40:36 -03:00
parent f341afe2fc
commit b6f6c29454
3 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
Documentation/driver-api/mtdnand.rst
View File

@ -970,9 +970,6 @@ hints" for an explanation.
.. kernel-doc:: drivers/mtd/nand/nand_base.c .. kernel-doc:: drivers/mtd/nand/nand_base.c
:export: :export:
.. kernel-doc:: drivers/mtd/nand/nand_bbt.c
:export:
.. kernel-doc:: drivers/mtd/nand/nand_ecc.c .. kernel-doc:: drivers/mtd/nand/nand_ecc.c
:export: :export:

7
drivers/mtd/nand/nand_base.c
View File

@ -442,10 +442,12 @@ static int nand_default_block_markbad(struct mtd_info *mtd, loff_t ofs)
* specify how to write bad block markers to OOB (chip->block_markbad). * specify how to write bad block markers to OOB (chip->block_markbad).
* *
* We try operations in the following order: * We try operations in the following order:
*
* (1) erase the affected block, to allow OOB marker to be written cleanly * (1) erase the affected block, to allow OOB marker to be written cleanly
* (2) write bad block marker to OOB area of affected block (unless flag * (2) write bad block marker to OOB area of affected block (unless flag
* NAND_BBT_NO_OOB_BBM is present) * NAND_BBT_NO_OOB_BBM is present)
* (3) update the BBT * (3) update the BBT
*
* Note that we retain the first error encountered in (2) or (3), finish the * Note that we retain the first error encountered in (2) or (3), finish the
* procedures, and dump the error in the end. * procedures, and dump the error in the end.
*/ */
@ -1155,9 +1157,10 @@ int nand_reset(struct nand_chip *chip, int chipnr)
* @mtd: mtd info * @mtd: mtd info
* @ofs: offset to start unlock from * @ofs: offset to start unlock from
* @len: length to unlock * @len: length to unlock
* @invert: when = 0, unlock the range of blocks within the lower and * @invert:
* - when = 0, unlock the range of blocks within the lower and
* upper boundary address * upper boundary address
* when = 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 * of the lower and upper boundary address
* *
* Returs unlock status. * Returs unlock status.