Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.kernel > #1642484

[PATCH v2 39/53] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings

From Mauro Carvalho Chehab <mchehab@s-opensource.com>
Newsgroups linux.kernel
Subject [PATCH v2 39/53] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings
Date 2017-05-16 14:20 +0200
Message-ID <tHJCi-5vb-27@gated-at.bofh.it> (permalink)
References <tHJCh-5vb-5@gated-at.bofh.it>
Organization linux.* mail to news gateway

Show all headers | View raw


./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>
---
 Documentation/driver-api/mtdnand.rst | 3 ---
 drivers/mtd/nand/nand_base.c         | 7 +++++--
 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.
 .. kernel-doc:: drivers/mtd/nand/nand_base.c
    :export:
 
-.. kernel-doc:: drivers/mtd/nand/nand_bbt.c
-   :export:
-
 .. kernel-doc:: drivers/mtd/nand/nand_ecc.c
    :export:
 
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)
  * specify how to write bad block markers to OOB (chip->block_markbad).
  *
  * We try operations in the following order:
+ *
  *  (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
  *      NAND_BBT_NO_OOB_BBM is present)
  *  (3) update the BBT
+ *
  * Note that we retain the first error encountered in (2) or (3), finish the
  * procedures, and dump the error in the end.
 */
@@ -1155,9 +1157,10 @@ int nand_reset(struct nand_chip *chip, int chipnr)
  * @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
+ * @invert:
+ *        - when = 0, unlock the range of blocks within the lower and
  *                    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
  *
  * 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)
  *			Minimum amount of bit errors per @ecc_step_ds guaranteed
  *			to be correctable. If unknown, set to zero.
  * @ecc_step_ds:	[INTERN] ECC step required by the @ecc_strength_ds,
- *                      also from the datasheet. It is the recommended ECC step
+ *			also from the datasheet. It is the recommended ECC step
  *			size, if known; if unknown, set to zero.
  * @onfi_timing_mode_default: [INTERN] default ONFI timing mode. This field is
  *			      set to the actually used ONFI mode if the chip is
-- 
2.9.3

Back to linux.kernel | Previous | NextPrevious in thread | Next in thread | Find similar | Unroll thread


Thread

[PATCH v2 00/53] Get rid of Docbook Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
  [PATCH v2 18/53] docs-rst: filesystems: use c domain references where needed Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
  [PATCH v2 06/53] locking.rst: add captions to two tables Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
  [PATCH v2 33/53] scsi: fix some kernel-doc markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
  [PATCH v2 17/53] docs-rst: convert filesystems book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
  [PATCH v2 39/53] mtd: adjust kernel-docs to avoid Sphinx/kerneldoc warnings Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:20 +0200
    Re: [PATCH v2 39/53] mtd: adjust kernel-docs to avoid  Sphinx/kerneldoc warnings Boris Brezillon <boris.brezillon@free-electrons.com> - 2017-05-16 15:20 +0200
  [PATCH v2 16/53] docs-rst: add userspace API book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 20/53] docs-rst: don't ignore internal functions for jbd2 docs Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 15/53] docs-rst: add sound book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    Re: [PATCH v2 15/53] docs-rst: add sound book to pdf output Takashi Iwai <tiwai@suse.de> - 2017-05-16 21:10 +0200
  [PATCH v2 31/53] docs-rst: convert z8530book DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 10/53] conf.py: define a color for important markup on PDF output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 44/53] MAINTAINERS: update old references for DocBook directory Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 02/53] kernel-hacking: update document Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    [PATCH v2 53/53] kernel-doc: describe the ``literal`` syntax Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
    [PATCH v2 52/53] docs-rst: get rid of Documentation/sphinx/tmplcvt script Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
    [PATCH v2 50/53] fs: fix the location of the kernel-api book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
    [PATCH v2 51/53] usb: fix the comment with regards to DocBook Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:20 +0200
      Re: [PATCH v2 51/53] usb: fix the comment with regards to DocBook Felipe Balbi <balbi@kernel.org> - 2017-05-17 13:20 +0200
  [PATCH v2 14/53] docs-rst: add dev-tools book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 29/53] net: skbuff.h: properly escape a macro name on kernel-doc Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 07/53] locking.rst: Update some ReST markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 09/53] kgdb.rst: Adjust ReST markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 47/53] irq: update genericirq book location Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 41/53] docs-rst: convert lsm from DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 46/53] ia64, scsi: update references for the device-io book Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 05/53] locking.rst: reformat locking table Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 25/53] libata.rst: add c function and struct cross-references Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 36/53] docs-rst: convert librs book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 42/53] docs: remove DocBook from the building system Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 32/53] docs-rst: convert scsi DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 48/53] fs: update location of filesystems documentation Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 34/53] docs-rst: convert w1 book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 49/53] lib: update location of kgdb documentation Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 28/53] docs-rst: convert networking book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    Re: [PATCH v2 30/53] net: fix some identation issues at kernel-doc markups David Howells <dhowells@redhat.com> - 2017-05-16 14:40 +0200
  [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-16 19:40 +0200
      Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to  generate ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 20:30 +0200
        Re: [PATCH v2 04/53] mutex, futex: adjust kernel-doc markups to  generate ReST Darren Hart <dvhart@infradead.org> - 2017-05-16 21:10 +0200
  [PATCH v2 21/53] fs: add a blank lines on some kernel-doc comments Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 11/53] docs-rst: conf.py: sort LaTeX documents in alphabetical order Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 12/53] docs-rst: conf.py: remove kernel-documentation from LaTeX Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
  [PATCH v2 43/53] docs: update old references for DocBook from the documentation Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:30 +0200
    Re: [PATCH v2 43/53] docs: update old references for DocBook from  the documentation Bjorn Helgaas <helgaas@kernel.org> - 2017-05-17 19:00 +0200
  [PATCH v2 13/53] docs-rst: add crypto API book to pdf output Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
  [PATCH v2 22/53] fs: eventfd: fix identation on kernel-doc Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
  [PATCH v2 35/53] docs-rst: convert rapidio book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
  [PATCH v2 27/53] docs-rst: convert s390-drivers DocBook to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
  [PATCH v2 26/53] libata: fix identation on a kernel-doc markup Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
  [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
    Re: [PATCH v2 38/53] mtdnand.rst: group the "::" with previous line Boris Brezillon <boris.brezillon@free-electrons.com> - 2017-05-16 15:20 +0200
  [PATCH v2 40/53] docs-rst: convert sh book to ReST Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-16 14:40 +0200
  Re: [PATCH v2 00/53] Get rid of Docbook Jonathan Corbet <corbet@lwn.net> - 2017-05-18 19:30 +0200
    Re: [PATCH v2 00/53] Get rid of Docbook Mauro Carvalho Chehab <mchehab@s-opensource.com> - 2017-05-19 01:10 +0200

csiph-web