Re: [PATCH 01/17] mtd: rawnand: cafe: Get rid of an inaccurate kernel doc header

[Miquel Raynal <miquel.raynal@xxxxxxxxxxx>]

Hi Boris,

Boris Brezillon <boris.brezillon@xxxxxxxxxxxxx> wrote on Mon, 27 Apr
2020 10:20:11 +0200:

> Driver files are not parsed for doc generation, and the
> cafe_nand_read_page() kernel-doc header was wrong, so let's get rid of
> it.

Really? I didn't know. I like kernel doc syntax which is simple and
colorful when you have a decent editor but in this case it is indeed
useless.

Reviewed-by: Miquel Raynal <miquel.raynal@xxxxxxxxxxx>
 
> 
> Signed-off-by: Boris Brezillon <boris.brezillon@xxxxxxxxxxxxx>
> ---
>  drivers/mtd/nand/raw/cafe_nand.c | 9 ++-------
>  1 file changed, 2 insertions(+), 7 deletions(-)
> 
> diff --git a/drivers/mtd/nand/raw/cafe_nand.c b/drivers/mtd/nand/raw/cafe_nand.c
> index 2a0df13df5f3..1296380a4996 100644
> --- a/drivers/mtd/nand/raw/cafe_nand.c
> +++ b/drivers/mtd/nand/raw/cafe_nand.c
> @@ -357,13 +357,8 @@ static int cafe_nand_read_oob(struct nand_chip *chip, int page)
>  
>  	return nand_read_oob_op(chip, page, 0, chip->oob_poi, mtd->oobsize);
>  }
> -/**
> - * cafe_nand_read_page_syndrome - [REPLACEABLE] hardware ecc syndrome based page read
> - * @mtd:	mtd info structure
> - * @chip:	nand chip info structure
> - * @buf:	buffer to store read data
> - * @oob_required:	caller expects OOB data read to chip->oob_poi
> - *
> +
> +/*
>   * The hw generator calculates the error syndrome automatically. Therefore
>   * we need a special oob layout and handling.
>   */


Thanks,
Miquèl

______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/