lkml.org 
[lkml]   [2021]   [Jun]   [2]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
From
Date
SubjectRe: [PATCH] mtd: rawnand: marvell: Minor documentation correction
On Sun, Apr 25, 2021 at 9:52 PM Randy Dunlap <rdunlap@infradead.org> wrote:
>
> 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@intel.com>
> > Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com>
> > Cc: Randy Dunlap <rdunlap@infradead.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.

Sorry, I missed this thread. yes it's wrong.
Reason -> I posted the wrong patch.
I will correct it in v2.

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

\
 
 \ /
  Last update: 2021-06-02 10:23    [W:0.037 / U:1.412 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site