Messages in this thread | | | Subject | Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction | From | Randy Dunlap <> | Date | Sun, 25 Apr 2021 09:21:44 -0700 |
| |
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.
[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
| |