Message ID | 20210607193736.4654-1-jrdr.linux@gmail.com |
---|---|
State | Accepted |
Headers | show |
Series | [v2] mtd: rawnand: marvell: Minor documentation correction | expand |
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@intel.com> > Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com> > Cc: Randy Dunlap <rdunlap@infradead.org> LGTM. Thanks. Acked-by: Randy Dunlap <rdunlap@infradead.org> > --- > 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 >
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 <lkp@intel.com> > Signed-off-by: Souptick Joarder <jrdr.linux@gmail.com> > Cc: Randy Dunlap <rdunlap@infradead.org> > Acked-by: Randy Dunlap <rdunlap@infradead.org> Applied to https://git.kernel.org/pub/scm/linux/kernel/git/mtd/linux.git nand/next, thanks. Miquel
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
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> --- v2: Address review comment. drivers/mtd/nand/raw/marvell_nand.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)