From: Miquel Raynal <miquel.raynal@bootlin.com>
To: Lee Jones <lee.jones@linaro.org>
Cc: Adrian Hunter <ext-adrian.hunter@nokia.com>,
Richard Weinberger <richard@nod.at>,
linux-kernel@vger.kernel.org,
Kyungmin Park <kyungmin.park@samsung.com>,
linux-mtd@lists.infradead.org, vigneshr@ti.com
Subject: Re: [PATCH 22/23] mtd: nand: onenand: onenand_base: Fix some kernel-doc misdemeanours
Date: Mon, 2 Nov 2020 13:51:10 +0100 [thread overview]
Message-ID: <20201102135110.38a4df50@xps13> (raw)
In-Reply-To: <20201102115406.1074327-23-lee.jones@linaro.org>
Hi Lee,
Lee Jones <lee.jones@linaro.org> wrote on Mon, 2 Nov 2020 11:54:05
+0000:
> Fixes the following W=1 kernel build warning(s):
>
> drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'mtd' not described in 'onenand_ooblayout_32_64_ecc'
> drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'section' not described in 'onenand_ooblayout_32_64_ecc'
> drivers/mtd/nand/onenand/onenand_base.c:140: warning: Function parameter or member 'oobregion' not described in 'onenand_ooblayout_32_64_ecc'
> drivers/mtd/nand/onenand/onenand_base.c:279: warning: Function parameter or member 'dataram1' not described in 'onenand_buffer_address'
> drivers/mtd/nand/onenand/onenand_base.c:279: warning: Excess function parameter 'dataram' description in 'onenand_buffer_address'
> drivers/mtd/nand/onenand/onenand_base.c:1436: warning: bad line:
> drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Function parameter or member 'ops' not described in 'onenand_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'len' description in 'onenand_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'retlen' description in 'onenand_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'buf' description in 'onenand_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:1971: warning: Excess function parameter 'mode' description in 'onenand_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:2156: warning: Function parameter or member 'block_size' not described in 'onenand_multiblock_erase'
> drivers/mtd/nand/onenand/onenand_base.c:2156: warning: Excess function parameter 'region' description in 'onenand_multiblock_erase'
> drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Function parameter or member 'ops' not described in 'onenand_otp_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Excess function parameter 'len' description in 'onenand_otp_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Excess function parameter 'retlen' description in 'onenand_otp_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:2771: warning: Excess function parameter 'buf' description in 'onenand_otp_write_oob_nolock'
> drivers/mtd/nand/onenand/onenand_base.c:3387: warning: Function parameter or member 'mtd' not described in 'flexonenand_get_boundary'
> drivers/mtd/nand/onenand/onenand_base.c:3387: warning: Excess function parameter 'onenand_info' description in 'flexonenand_get_boundary'
> drivers/mtd/nand/onenand/onenand_base.c:3509: warning: Function parameter or member 'mtd' not described in 'flexonenand_check_blocks_erased'
> drivers/mtd/nand/onenand/onenand_base.c:3509: warning: Excess function parameter 'mtd_info' description in 'flexonenand_check_blocks_erased'
> drivers/mtd/nand/onenand/onenand_base.c:3557: warning: Function parameter or member 'die' not described in 'flexonenand_set_boundary'
> drivers/mtd/nand/onenand/onenand_base.c:3557: warning: Function parameter or member 'boundary' not described in 'flexonenand_set_boundary'
> drivers/mtd/nand/onenand/onenand_base.c:3557: warning: Function parameter or member 'lock' not described in 'flexonenand_set_boundary'
>
> Cc: Kyungmin Park <kyungmin.park@samsung.com>
> Cc: Miquel Raynal <miquel.raynal@bootlin.com>
> Cc: Richard Weinberger <richard@nod.at>
> Cc: Vignesh Raghavendra <vigneshr@ti.com>
> Cc: Adrian Hunter <ext-adrian.hunter@nokia.com>
> Cc: linux-mtd@lists.infradead.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
> drivers/mtd/nand/onenand/onenand_base.c | 38 +++++++++++--------------
> 1 file changed, 16 insertions(+), 22 deletions(-)
>
> diff --git a/drivers/mtd/nand/onenand/onenand_base.c b/drivers/mtd/nand/onenand/onenand_base.c
> index 35f851bf90a3c..a9fdea26ea464 100644
> --- a/drivers/mtd/nand/onenand/onenand_base.c
> +++ b/drivers/mtd/nand/onenand/onenand_base.c
> @@ -132,7 +132,7 @@ static const struct mtd_ooblayout_ops onenand_oob_128_ooblayout_ops = {
> .free = onenand_ooblayout_128_free,
> };
>
> -/**
> +/*
> * onenand_oob_32_64 - oob info for large (2KB) page
> */
> static int onenand_ooblayout_32_64_ecc(struct mtd_info *mtd, int section,
> @@ -268,10 +268,10 @@ static int onenand_page_address(int page, int sector)
>
> /**
> * onenand_buffer_address - [DEFAULT] Get buffer address
> - * @dataram:1 DataRAM index
> + * @dataram1: DataRAM index
It looks like this is a fix of patch 03/23 :) Maybe this entire patch
can be squashed with patch 03/23 btw?
> * @sectors: the sector address
> * @count: the number of sectors
> - * @return the start buffer value
> + * Return: the start buffer value
> *
> * Setup Start Buffer Register (F200h)
> */
Thanks,
Miquèl
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
next prev parent reply other threads:[~2020-11-02 12:52 UTC|newest]
Thread overview: 36+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20201102115406.1074327-1-lee.jones@linaro.org>
2020-11-02 11:53 ` [PATCH 01/23] mtd: mtdpart: Fix misdocumented function parameter 'mtd' Lee Jones
2020-11-02 11:53 ` [PATCH 02/23] mtd: devices: phram: File headers are not good candidates for kernel-doc Lee Jones
2020-11-02 11:53 ` [PATCH 03/23] mtd: nand: onenand: onenand_base: Fix expected kernel-doc formatting Lee Jones
2020-11-02 12:33 ` Miquel Raynal
2020-11-02 11:53 ` [PATCH 04/23] mtd: devices: docg3: Fix kernel-doc 'bad line' and 'excessive doc' issues Lee Jones
2020-11-02 12:34 ` Miquel Raynal
2020-11-02 11:53 ` [PATCH 05/23] mtd: mtdcore: Fix misspelled function parameter 'section' Lee Jones
2020-11-02 11:53 ` [PATCH 06/23] mtd: nand: onenand: onenand_bbt: Fix expected kernel-doc formatting Lee Jones
2020-11-02 11:53 ` [PATCH 07/23] mtd: spi-nor: controllers: hisi-sfc: Demote non-conformant kernel-doc Lee Jones
2020-11-06 13:37 ` Vignesh Raghavendra
2020-11-02 11:53 ` [PATCH 08/23] mtd: ubi: build: Document 'ubi_num' in struct mtd_dev_param Lee Jones
2020-11-02 11:53 ` [PATCH 09/23] mtd: nand: spi: toshiba: Demote non-conformant kernel-doc header Lee Jones
2020-11-02 12:29 ` Frieder Schrempf
2020-11-02 11:53 ` [PATCH 10/23] mtd: ubi: kapi: Correct documentation for 'ubi_leb_read_sg's 'sgl' parameter Lee Jones
2020-11-02 11:53 ` [PATCH 11/23] mtd: ubi: eba: Fix a couple of misdocumentation issues Lee Jones
2020-11-02 11:53 ` [PATCH 12/23] mtd: ubi: wl: Fix a couple of kernel-doc issues Lee Jones
2020-11-02 11:53 ` [PATCH 13/23] mtd: nand: raw: brcmnand: brcmnand: Demote non-conformant kernel-doc headers Lee Jones
2020-11-04 3:38 ` Florian Fainelli
2020-11-02 11:53 ` [PATCH 14/23] mtd: ubi: gluebi: Fix misnamed function parameter documentation Lee Jones
2020-11-02 11:53 ` [PATCH 15/23] mtd: nand: raw: diskonchip: Marking unused variables as __always_unused Lee Jones
2020-11-02 11:53 ` [PATCH 16/23] mtd: nand: raw: cafe_nand: Remove superfluous param doc and add another Lee Jones
2020-11-02 11:54 ` [PATCH 17/23] mtd: nand: raw: s3c2410: Add documentation for 2 missing struct members Lee Jones
2020-11-02 12:41 ` Krzysztof Kozlowski
2020-11-02 11:54 ` [PATCH 18/23] mtd: nand: raw: omap_elm: Finish half populated function header, demote empty ones Lee Jones
2020-11-02 11:54 ` [PATCH 19/23] mtd: nand: raw: omap2: Fix a bunch of kernel-doc misdemeanours Lee Jones
2020-11-02 12:44 ` Miquel Raynal
2020-11-02 11:54 ` [PATCH 20/23] mtd: nand: raw: sunxi_nand: Document 'sunxi_nfc's 'caps' member Lee Jones
2020-11-02 12:48 ` Miquel Raynal
2020-11-02 11:54 ` [PATCH 21/23] mtd: nand: raw: arasan-nand-controller: Document 'anfc_op's 'buf' member Lee Jones
2020-11-02 11:54 ` [PATCH 22/23] mtd: nand: onenand: onenand_base: Fix some kernel-doc misdemeanours Lee Jones
2020-11-02 12:51 ` Miquel Raynal [this message]
2020-11-02 11:54 ` [PATCH 23/23] mtd: devices: powernv_flash: Add function names to headers and fix 'dev' Lee Jones
2020-11-02 12:52 ` Miquel Raynal
2020-11-06 13:32 ` [PATCH 00/23] Rid W=1 warnings in MTD Lee Jones
2020-11-06 13:44 ` Miquel Raynal
2020-11-06 14:33 ` Lee Jones
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201102135110.38a4df50@xps13 \
--to=miquel.raynal@bootlin.com \
--cc=ext-adrian.hunter@nokia.com \
--cc=kyungmin.park@samsung.com \
--cc=lee.jones@linaro.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-mtd@lists.infradead.org \
--cc=richard@nod.at \
--cc=vigneshr@ti.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox