Re: [PATCH 04/23] mtd: devices: docg3: Fix kernel-doc 'bad line' and 'excessive doc' issues

Miquel Raynal
2020-11-02T12:35:04Z

Hi Lee,

Lee Jones <lee.jones@linaro.org> wrote on Mon, 2 Nov 2020 11:53:47
+0000:

> Fixes the following W=1 kernel build warning(s):
>
> drivers/mtd/devices/docg3.c:819: warning: bad line:
> drivers/mtd/devices/docg3.c:1799: warning: Excess function parameter 'base' description in 'doc_probe_device'
>
> Cc: Robert Jarzmik <robert.jarzmik@free.fr>
> Cc: Miquel Raynal <miquel.raynal@bootlin.com>
> Cc: Richard Weinberger <richard@nod.at>
> Cc: Vignesh Raghavendra <vigneshr@ti.com>
> Cc: linux-mtd@lists.infradead.org
> Signed-off-by: Lee Jones <lee.jones@linaro.org>
> ---
> drivers/mtd/devices/docg3.c | 5 ++---
> 1 file changed, 2 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/mtd/devices/docg3.c b/drivers/mtd/devices/docg3.c
> index a030792115bc2..5b0ae5ddad745 100644
> --- a/drivers/mtd/devices/docg3.c
> +++ b/drivers/mtd/devices/docg3.c
> @@ -816,7 +816,7 @@ static void doc_read_page_finish(struct docg3 *docg3)
>
> /**
> * calc_block_sector - Calculate blocks, pages and ofs.
> -
> + *
> * @from: offset in flash
> * @block0: first plane block index calculated
> * @block1: second plane block index calculated
> @@ -1783,10 +1783,9 @@ static int __init doc_set_driver_info(int chip_id, struct mtd_info *mtd)
>
> /**
> * doc_probe_device - Check if a device is available
> - * @base: the io space where the device is probed
> + * @cascade: the cascade of chips this devices will belong to
> * @floor: the floor of the probed device
> * @dev: the device
> - * @cascade: the cascade of chips this devices will belong to
> *
> * Checks whether a device at the specified IO range, and floor is available.
> *

You also reorder the parameters in the kdoc which is not stated in the
commit log. But that's nitpicking...

Thanks,
Miquèl