2021-06-07 19:41:58

by Souptick Joarder

Subject: [PATCH v2] mtd: rawnand: marvell: Minor documentation correction

Kernel test robot throws below warning ->
drivers/mtd/nand/raw/marvell_nand.c:454: warning: This comment starts
with '/**', but isn't a kernel-doc comment. Refer
Documentation/doc-guide/kernel-doc.rst

Minor documentation correction.

Reported-by: kernel test robot <[email protected]>
Signed-off-by: Souptick Joarder <[email protected]>
Cc: Randy Dunlap <[email protected]>
---
v2:
Address review comment.

drivers/mtd/nand/raw/marvell_nand.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/mtd/nand/raw/marvell_nand.c b/drivers/mtd/nand/raw/marvell_nand.c
index 79da6b02e209..f4efdb59467d 100644
--- a/drivers/mtd/nand/raw/marvell_nand.c
+++ b/drivers/mtd/nand/raw/marvell_nand.c
@@ -451,7 +451,7 @@ struct marvell_nfc_timings {
};

/**
- * Derives a duration in numbers of clock cycles.
+ * TO_CYCLES() - Derives a duration in numbers of clock cycles.
*
* @ps: Duration in pico-seconds
* @period_ns: Clock period in nano-seconds
--
2.25.1

2021-06-07 20:15:27

by Randy Dunlap

Subject: Re: [PATCH v2] mtd: rawnand: marvell: Minor documentation correction

On 6/7/21 12:37 PM, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
> drivers/mtd/nand/raw/marvell_nand.c:454: warning: This comment starts
> with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>
> Minor documentation correction.
>
> Reported-by: kernel test robot <[email protected]>
> Signed-off-by: Souptick Joarder <[email protected]>
> Cc: Randy Dunlap <[email protected]>

LGTM. Thanks.

Acked-by: Randy Dunlap <[email protected]>


> ---
> v2:
> Address review comment.
>
> drivers/mtd/nand/raw/marvell_nand.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/drivers/mtd/nand/raw/marvell_nand.c b/drivers/mtd/nand/raw/marvell_nand.c
> index 79da6b02e209..f4efdb59467d 100644
> --- a/drivers/mtd/nand/raw/marvell_nand.c
> +++ b/drivers/mtd/nand/raw/marvell_nand.c
> @@ -451,7 +451,7 @@ struct marvell_nfc_timings {
> };
>
> /**
> - * Derives a duration in numbers of clock cycles.
> + * TO_CYCLES() - Derives a duration in numbers of clock cycles.
> *
> * @ps: Duration in pico-seconds
> * @period_ns: Clock period in nano-seconds
>


--
~Randy

2021-06-11 19:04:41

by Miquel Raynal

Subject: Re: [PATCH v2] mtd: rawnand: marvell: Minor documentation correction

On Mon, 2021-06-07 at 19:37:36 UTC, Souptick Joarder wrote:
> Kernel test robot throws below warning ->
> drivers/mtd/nand/raw/marvell_nand.c:454: warning: This comment starts
> with '/**', but isn't a kernel-doc comment. Refer
> Documentation/doc-guide/kernel-doc.rst
>
> Minor documentation correction.
>
> Reported-by: kernel test robot <[email protected]>
> Signed-off-by: Souptick Joarder <[email protected]>
> Cc: Randy Dunlap <[email protected]>
> Acked-by: Randy Dunlap <[email protected]>

Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next, thanks.

Miquel