[PATCH 0/2] Fix some function description mismatches

[PATCH 0/2] Fix some function description mismatches

[Xiaolei Li]

This patch fixes some function description mismatches.

Changes relative to:
--------------------

tree	: https://github.com/bbrezillon/linux-0day
branch	: nand/next
commit	:
	'commit ba4150b1ec2a ("mtd: rawnand: s3c2410: enhance the probe
	function error path")'

Xiaolei Li (2):
  mtd: Fix some function description mismatches in mtdcore.c
  mtd: nand: Fix some function description mismatches in core.c

 drivers/mtd/mtdcore.c   |  8 ++++----
 drivers/mtd/nand/core.c | 12 ++++++------
 2 files changed, 10 insertions(+), 10 deletions(-)

-- 
1.9.1

[PATCH 1/2] mtd: Fix some function description mismatches in mtdcore.c

[Xiaolei Li]

In mtdcore.c, some function descriptions do not match function
definitions. Just fix these mismatches.

Signed-off-by: Xiaolei Li <xiaolei.li@mediatek.com>
---
 drivers/mtd/mtdcore.c | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/mtd/mtdcore.c b/drivers/mtd/mtdcore.c
index 28553c8..413ea9b 100644
--- a/drivers/mtd/mtdcore.c
+++ b/drivers/mtd/mtdcore.c
@@ -419,7 +419,7 @@ int mtd_wunit_to_pairing_info(struct mtd_info *mtd, int wunit,
 EXPORT_SYMBOL_GPL(mtd_wunit_to_pairing_info);
 
 /**
- * mtd_wunit_to_pairing_info - get wunit from pairing information
+ * mtd_pairing_info_to_wunit - get wunit from pairing information
  * @mtd: pointer to new MTD device info structure
  * @info: pairing information struct
  *
@@ -1525,9 +1525,9 @@ int mtd_ooblayout_get_databytes(struct mtd_info *mtd, u8 *databuf,
 EXPORT_SYMBOL_GPL(mtd_ooblayout_get_databytes);
 
 /**
- * mtd_ooblayout_get_eccbytes - set data bytes into the oob buffer
+ * mtd_ooblayout_set_databytes - set data bytes into the oob buffer
  * @mtd: mtd info structure
- * @eccbuf: source buffer to get data bytes from
+ * @databuf: source buffer to get data bytes from
  * @oobbuf: OOB buffer
  * @start: first ECC byte to set
  * @nbytes: number of ECC bytes to set
@@ -1559,7 +1559,7 @@ int mtd_ooblayout_count_freebytes(struct mtd_info *mtd)
 EXPORT_SYMBOL_GPL(mtd_ooblayout_count_freebytes);
 
 /**
- * mtd_ooblayout_count_freebytes - count the number of ECC bytes in OOB
+ * mtd_ooblayout_count_eccbytes - count the number of ECC bytes in OOB
  * @mtd: mtd info structure
  *
  * Works like mtd_ooblayout_count_bytes(), except it count ECC bytes.
-- 
1.9.1

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

[Xiaolei Li]

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
  *
- * 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.
  *
  * Return: 0 in case of success, a negative error code otherwise.
  */
-- 
1.9.1

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

[Boris Brezillon]

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.

>   *
> - * 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

Anyway, thanks for reporting and fixing those problems in the doc.

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



-- 
Boris Brezillon, Bootlin (formerly Free Electrons)
Embedded Linux and Kernel engineering
https://bootlin.com

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

[xiaolei li]

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.
> >   */
> 
> 
> 

Re: [PATCH 0/2] Fix some function description mismatches

[Richard Weinberger]

Am Mittwoch, 28. März 2018, 11:13:56 CEST schrieb Xiaolei Li:
> This patch fixes some function description mismatches.

Did you find these manually or in some automated way?

Thanks,
//richard

Re: [PATCH 0/2] Fix some function description mismatches

[xiaolei li]

Hi Richard

On Wed, 2018-03-28 at 14:06 +0200, Richard Weinberger wrote:
> Am Mittwoch, 28. März 2018, 11:13:56 CEST schrieb Xiaolei Li:
> > This patch fixes some function description mismatches.
> 
> Did you find these manually or in some automated way?

I found these by accident. Do you know whether there is a tool to do
comments check? 

Thanks.
Xiaolei

> 
> Thanks,
> //richard