Re: [PATCH 2/2] mtd: nand: Fix some function description mismatches in core.c

xiaolei li
2018-03-29T01:04:41Z

On Wed, 2018-03-28 at 13:37 +0200, Boris Brezillon wrote:
> On Wed, 28 Mar 2018 17:13:58 +0800
> Xiaolei Li <xiaolei.li@mediatek.com> wrote:
>
> > In core.c, some function descriptions do not match function
> > definitions. Just fix these mismatches.
> >
> > Signed-off-by: Xiaolei Li <xiaolei.li@mediatek.com>
> > ---
> > drivers/mtd/nand/core.c | 12 ++++++------
> > 1 file changed, 6 insertions(+), 6 deletions(-)
> >
> > diff --git a/drivers/mtd/nand/core.c b/drivers/mtd/nand/core.c
> > index f237a68..9f6febd 100644
> > --- a/drivers/mtd/nand/core.c
> > +++ b/drivers/mtd/nand/core.c
> > @@ -51,7 +51,7 @@ bool nanddev_isbad(struct nand_device *nand, const struct nand_pos *pos)
> > /**
> > * nanddev_markbad() - Mark a block as bad
> > * @nand: NAND device
> > - * @block: block to mark bad
> > + * @pos: position of the block to mark bad
> > *
> > * Mark a block bad. This function is updating the BBT if available and
> > * calls the low-level markbad hook (nand->ops->markbad()).
> > @@ -117,9 +117,9 @@ bool nanddev_isreserved(struct nand_device *nand, const struct nand_pos *pos)
> > /**
> > * nanddev_erase() - Erase a NAND portion
> > * @nand: NAND device
> > - * @block: eraseblock to erase
> > + * @pos: position of the block to erase
> > *
> > - * Erases @block if it's not bad.
> > + * Erases the block if it's not bad.
> > *
> > * Return: 0 in case of success, a negative error code otherwise.
> > */
> > @@ -179,11 +179,11 @@ int nanddev_mtd_erase(struct mtd_info *mtd, struct erase_info *einfo)
> > /**
> > * nanddev_init() - Initialize a NAND device
> > * @nand: NAND device
> > - * @memorg: NAND memory organization descriptor
> > * @ops: NAND device operations
> > + * @owner: MTD module owner
>
> ^ NAND device owner.
OK. Thanks
>
> > *
> > - * Initializes a NAND device object. Consistency checks are done on @memorg and
> > - * @ops. Also takes care of initializing the BBT.
> > + * Initializes a NAND device object. Consistency checks are done on @ops and
> > + * nand memory organization. Also takes care of initializing the BBT.
>
> Don't remember the exact format, but I thing you can use something
> @nand->memorg
OK. Thanks.
>
> Anyway, thanks for reporting and fixing those problems in the doc.
Welcome.

Thanks.
Xiaolei
>
> > *
> > * Return: 0 in case of success, a negative error code otherwise.
> > */
>
>
>