2019-01-28 02:22:37

by Randy Dunlap

Subject: [PATCH] mtd: nand: fix kernel-doc warnings

From: Randy Dunlap <[email protected]>

Fix kernel-doc warnings in drivers/mtd/nand/raw:

../drivers/mtd/nand/raw/nand_base.c:420: warning: Function parameter or member 'chip' not described in 'nand_fill_oob'
../drivers/mtd/nand/raw/nand_bbt.c:173: warning: Function parameter or member 'this' not described in 'read_bbt'
../drivers/mtd/nand/raw/nand_bbt.c:173: warning: Excess function parameter 'chip' description in 'read_bbt'

Signed-off-by: Randy Dunlap <[email protected]>
Cc: Boris Brezillon <[email protected]>
Cc: Miquel Raynal <[email protected]>
Cc: Richard Weinberger <[email protected]>
Cc: [email protected]
---
Do you want Fixes: tags for these:

Fixes: 0813621ba898a ("mtd: rawnand: Stop passing mtd_info objects to internal functions")
Fixes: 99f3351a6d6e0 ("mtd: rawnand: Reorganize code to avoid forward declarations")

drivers/mtd/nand/raw/nand_base.c | 1 +
drivers/mtd/nand/raw/nand_bbt.c | 2 +-
2 files changed, 2 insertions(+), 1 deletion(-)

--- lnx-50-rc4.orig/drivers/mtd/nand/raw/nand_base.c
+++ lnx-50-rc4/drivers/mtd/nand/raw/nand_base.c
@@ -410,6 +410,7 @@ static int nand_check_wp(struct nand_chi

/**
* nand_fill_oob - [INTERN] Transfer client buffer to oob
+ * @chip: NAND chip object
* @oob: oob data buffer
* @len: oob data write length
* @ops: oob ops structure
--- lnx-50-rc4.orig/drivers/mtd/nand/raw/nand_bbt.c
+++ lnx-50-rc4/drivers/mtd/nand/raw/nand_bbt.c
@@ -158,7 +158,7 @@ static u32 add_marker_len(struct nand_bb

/**
* read_bbt - [GENERIC] Read the bad block table starting from page
- * @chip: NAND chip object
+ * @this: NAND chip object
* @buf: temporary buffer
* @page: the starting page
* @num: the number of bbt descriptors to read

2019-01-28 09:45:31

by Boris Brezillon

Subject: Re: [PATCH] mtd: nand: fix kernel-doc warnings

On Sun, 27 Jan 2019 18:21:42 -0800
Randy Dunlap <[email protected]> wrote:

> From: Randy Dunlap <[email protected]>
>
> Fix kernel-doc warnings in drivers/mtd/nand/raw:
>
> ../drivers/mtd/nand/raw/nand_base.c:420: warning: Function parameter or member 'chip' not described in 'nand_fill_oob'
> ../drivers/mtd/nand/raw/nand_bbt.c:173: warning: Function parameter or member 'this' not described in 'read_bbt'
> ../drivers/mtd/nand/raw/nand_bbt.c:173: warning: Excess function parameter 'chip' description in 'read_bbt'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Boris Brezillon <[email protected]>
> Cc: Miquel Raynal <[email protected]>
> Cc: Richard Weinberger <[email protected]>
> Cc: [email protected]
> ---
> Do you want Fixes: tags for these:
>
> Fixes: 0813621ba898a ("mtd: rawnand: Stop passing mtd_info objects to internal functions")

Will add this one.

> Fixes: 99f3351a6d6e0 ("mtd: rawnand: Reorganize code to avoid forward declarations")

Well, I don't think that one is responsible for the new warnings since
all I did was moving code around.

Thanks,

Boris

>
> drivers/mtd/nand/raw/nand_base.c | 1 +
> drivers/mtd/nand/raw/nand_bbt.c | 2 +-
> 2 files changed, 2 insertions(+), 1 deletion(-)
>
> --- lnx-50-rc4.orig/drivers/mtd/nand/raw/nand_base.c
> +++ lnx-50-rc4/drivers/mtd/nand/raw/nand_base.c
> @@ -410,6 +410,7 @@ static int nand_check_wp(struct nand_chi
>
> /**
> * nand_fill_oob - [INTERN] Transfer client buffer to oob
> + * @chip: NAND chip object
> * @oob: oob data buffer
> * @len: oob data write length
> * @ops: oob ops structure
> --- lnx-50-rc4.orig/drivers/mtd/nand/raw/nand_bbt.c
> +++ lnx-50-rc4/drivers/mtd/nand/raw/nand_bbt.c
> @@ -158,7 +158,7 @@ static u32 add_marker_len(struct nand_bb
>
> /**
> * read_bbt - [GENERIC] Read the bad block table starting from page
> - * @chip: NAND chip object
> + * @this: NAND chip object
> * @buf: temporary buffer
> * @page: the starting page
> * @num: the number of bbt descriptors to read
>
>
>
> ______________________________________________________
> Linux MTD discussion mailing list
> http://lists.infradead.org/mailman/listinfo/linux-mtd/

2019-01-28 09:51:03

by Miquel Raynal

Subject: Re: [PATCH] mtd: nand: fix kernel-doc warnings

Hi Randy,

Boris Brezillon <[email protected]> wrote on Mon, 28 Jan 2019
10:43:38 +0100:

> On Sun, 27 Jan 2019 18:21:42 -0800
> Randy Dunlap <[email protected]> wrote:
>
> > From: Randy Dunlap <[email protected]>
> >
> > Fix kernel-doc warnings in drivers/mtd/nand/raw:

With the prefix changed to "mtd: rawnand:"

Acked-by: Miquel Raynal <[email protected]>


Thanks,
Miquèl

2019-01-31 11:32:47

by Boris Brezillon

Subject: Re: mtd: nand: fix kernel-doc warnings

On Mon, 2019-01-28 at 02:21:42 UTC, Randy Dunlap wrote:
> From: Randy Dunlap <[email protected]>
>
> Fix kernel-doc warnings in drivers/mtd/nand/raw:
>
> ../drivers/mtd/nand/raw/nand_base.c:420: warning: Function parameter or member 'chip' not described in 'nand_fill_oob'
> ../drivers/mtd/nand/raw/nand_bbt.c:173: warning: Function parameter or member 'this' not described in 'read_bbt'
> ../drivers/mtd/nand/raw/nand_bbt.c:173: warning: Excess function parameter 'chip' description in 'read_bbt'
>
> Signed-off-by: Randy Dunlap <[email protected]>
> Cc: Boris Brezillon <[email protected]>
> Cc: Miquel Raynal <[email protected]>
> Cc: Richard Weinberger <[email protected]>
> Cc: [email protected]

Applied to http://git.infradead.org/linux-mtd.git mtd/fixes, thanks.

Boris