* [PATCH] mtd: rawnand: marvell: Minor documentation correction
@ 2021-04-25 9:08 ` Souptick Joarder
0 siblings, 0 replies; 6+ messages in thread
From: Souptick Joarder @ 2021-04-25 9:08 UTC (permalink / raw)
To: miquel.raynal, richard, vigneshr
Cc: linux-mtd, linux-kernel, Souptick Joarder, Randy Dunlap
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.
*
* @ps: Duration in pico-seconds
* @period_ns: Clock period in nano-seconds
--
1.9.1
^ permalink raw reply related [flat|nested] 6+ messages in thread
* [PATCH] mtd: rawnand: marvell: Minor documentation correction
@ 2021-04-25 9:08 ` Souptick Joarder
0 siblings, 0 replies; 6+ messages in thread
From: Souptick Joarder @ 2021-04-25 9:08 UTC (permalink / raw)
To: miquel.raynal, richard, vigneshr
Cc: linux-mtd, linux-kernel, Souptick Joarder, Randy Dunlap
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.
*
* @ps: Duration in pico-seconds
* @period_ns: Clock period in nano-seconds
--
1.9.1
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply related [flat|nested] 6+ messages in thread
* Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction
2021-04-25 9:08 ` Souptick Joarder
@ 2021-04-25 16:21 ` Randy Dunlap
-1 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2021-04-25 16:21 UTC (permalink / raw)
To: Souptick Joarder, miquel.raynal, richard, vigneshr
Cc: linux-mtd, linux-kernel
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
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction
@ 2021-04-25 16:21 ` Randy Dunlap
0 siblings, 0 replies; 6+ messages in thread
From: Randy Dunlap @ 2021-04-25 16:21 UTC (permalink / raw)
To: Souptick Joarder, miquel.raynal, richard, vigneshr
Cc: linux-mtd, linux-kernel
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
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction
2021-04-25 16:21 ` Randy Dunlap
@ 2021-06-02 8:22 ` Souptick Joarder
-1 siblings, 0 replies; 6+ messages in thread
From: Souptick Joarder @ 2021-06-02 8:22 UTC (permalink / raw)
To: Randy Dunlap
Cc: miquel.raynal, Richard Weinberger, vigneshr, linux-mtd, linux-kernel
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
>
^ permalink raw reply [flat|nested] 6+ messages in thread
* Re: [PATCH] mtd: rawnand: marvell: Minor documentation correction
@ 2021-06-02 8:22 ` Souptick Joarder
0 siblings, 0 replies; 6+ messages in thread
From: Souptick Joarder @ 2021-06-02 8:22 UTC (permalink / raw)
To: Randy Dunlap
Cc: miquel.raynal, Richard Weinberger, vigneshr, linux-mtd, linux-kernel
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
>
______________________________________________________
Linux MTD discussion mailing list
http://lists.infradead.org/mailman/listinfo/linux-mtd/
^ permalink raw reply [flat|nested] 6+ messages in thread
end of thread, other threads:[~2021-06-02 8:43 UTC | newest]
Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-04-25 9:08 [PATCH] mtd: rawnand: marvell: Minor documentation correction Souptick Joarder
2021-04-25 9:08 ` Souptick Joarder
2021-04-25 16:21 ` Randy Dunlap
2021-04-25 16:21 ` Randy Dunlap
2021-06-02 8:22 ` Souptick Joarder
2021-06-02 8:22 ` Souptick Joarder
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.