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

From: Randy Dunlap
Date: Mon Jun 07 2021 - 16:13:52 EST


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 <lkp@xxxxxxxxx>
> Signed-off-by: Souptick Joarder <jrdr.linux@xxxxxxxxx>
> Cc: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>

LGTM. Thanks.

Acked-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>


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