linux-kernel - Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <24534cc6-e6dc-feda-1e2f-b9b3501845d9@infradead.org>
Date:   Sun, 25 Apr 2021 09:21:44 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Souptick Joarder <jrdr.linux@...il.com>, miquel.raynal@...tlin.com,
        richard@....at, vigneshr@...com
Cc:     linux-mtd@...ts.infradead.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction

On 4/25/21 2:08 AM, 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@...el.com>
> Signed-off-by: Souptick Joarder <jrdr.linux@...il.com>
> Cc: Randy Dunlap <rdunlap@...radead.org>
> ---
>  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 79da6b0..e7b48d4 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.

Hi--

Did you test that?  I would be surprised if kernel-doc stays quiet
with that change.

[testing]

Yep, kernel-doc doesn't like to see that '*' there.
That doesn't work.

>   *
>   * @ps: Duration in pico-seconds
>   * @period_ns:  Clock period in nano-seconds
> 


-- 
~Randy