* [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning
@ 2019-06-05 20:46 Qian Cai
2019-06-27 19:55 ` Qian Cai
` (2 more replies)
0 siblings, 3 replies; 4+ messages in thread
From: Qian Cai @ 2019-06-05 20:46 UTC (permalink / raw)
To: mpe
Cc: ruscur, sbobroff, oohall, benh, paulus, linuxppc-dev,
linux-kernel, Qian Cai
The opening comment mark "/**" is reserved for kernel-doc comments, so
it will generate a warning with "make W=1".
arch/powerpc/kernel/eeh_cache.c:37: warning: cannot understand function
prototype: 'struct pci_io_addr_range
Since this is not a kernel-doc for the struct below, but rather an
overview of this source eeh_cache.c, just use the free-form comments
kernel-doc syntax instead.
Signed-off-by: Qian Cai <cai@lca.pw>
---
arch/powerpc/kernel/eeh_cache.c | 3 +++
1 file changed, 3 insertions(+)
diff --git a/arch/powerpc/kernel/eeh_cache.c b/arch/powerpc/kernel/eeh_cache.c
index 320472373122..05ffd32b3416 100644
--- a/arch/powerpc/kernel/eeh_cache.c
+++ b/arch/powerpc/kernel/eeh_cache.c
@@ -18,6 +18,8 @@
/**
+ * DOC: Overview
+ *
* The pci address cache subsystem. This subsystem places
* PCI device address resources into a red-black tree, sorted
* according to the address range, so that given only an i/o
@@ -34,6 +36,7 @@
* than any hash algo I could think of for this problem, even
* with the penalty of slow pointer chases for d-cache misses).
*/
+
struct pci_io_addr_range {
struct rb_node rb_node;
resource_size_t addr_lo;
--
1.8.3.1
^ permalink raw reply related [flat|nested] 4+ messages in thread
* Re: [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning
2019-06-05 20:46 [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning Qian Cai
@ 2019-06-27 19:55 ` Qian Cai
2019-06-28 3:02 ` Russell Currey
2019-07-03 14:27 ` Michael Ellerman
2 siblings, 0 replies; 4+ messages in thread
From: Qian Cai @ 2019-06-27 19:55 UTC (permalink / raw)
To: mpe; +Cc: ruscur, sbobroff, oohall, benh, paulus, linuxppc-dev, linux-kernel
Ping.
On Wed, 2019-06-05 at 16:46 -0400, Qian Cai wrote:
> The opening comment mark "/**" is reserved for kernel-doc comments, so
> it will generate a warning with "make W=1".
>
> arch/powerpc/kernel/eeh_cache.c:37: warning: cannot understand function
> prototype: 'struct pci_io_addr_range
>
> Since this is not a kernel-doc for the struct below, but rather an
> overview of this source eeh_cache.c, just use the free-form comments
> kernel-doc syntax instead.
>
> Signed-off-by: Qian Cai <cai@lca.pw>
> ---
> arch/powerpc/kernel/eeh_cache.c | 3 +++
> 1 file changed, 3 insertions(+)
>
> diff --git a/arch/powerpc/kernel/eeh_cache.c b/arch/powerpc/kernel/eeh_cache.c
> index 320472373122..05ffd32b3416 100644
> --- a/arch/powerpc/kernel/eeh_cache.c
> +++ b/arch/powerpc/kernel/eeh_cache.c
> @@ -18,6 +18,8 @@
>
>
> /**
> + * DOC: Overview
> + *
> * The pci address cache subsystem. This subsystem places
> * PCI device address resources into a red-black tree, sorted
> * according to the address range, so that given only an i/o
> @@ -34,6 +36,7 @@
> * than any hash algo I could think of for this problem, even
> * with the penalty of slow pointer chases for d-cache misses).
> */
> +
> struct pci_io_addr_range {
> struct rb_node rb_node;
> resource_size_t addr_lo;
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning
2019-06-05 20:46 [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning Qian Cai
2019-06-27 19:55 ` Qian Cai
@ 2019-06-28 3:02 ` Russell Currey
2019-07-03 14:27 ` Michael Ellerman
2 siblings, 0 replies; 4+ messages in thread
From: Russell Currey @ 2019-06-28 3:02 UTC (permalink / raw)
To: Qian Cai, mpe; +Cc: sbobroff, oohall, benh, paulus, linuxppc-dev, linux-kernel
On Wed, 2019-06-05 at 16:46 -0400, Qian Cai wrote:
> The opening comment mark "/**" is reserved for kernel-doc comments,
> so
> it will generate a warning with "make W=1".
>
> arch/powerpc/kernel/eeh_cache.c:37: warning: cannot understand
> function
> prototype: 'struct pci_io_addr_range
>
> Since this is not a kernel-doc for the struct below, but rather an
> overview of this source eeh_cache.c, just use the free-form comments
> kernel-doc syntax instead.
>
> Signed-off-by: Qian Cai <cai@lca.pw>
Looks good to me.
Acked-by: Russell Currey <ruscur@russell.cc>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning
2019-06-05 20:46 [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning Qian Cai
2019-06-27 19:55 ` Qian Cai
2019-06-28 3:02 ` Russell Currey
@ 2019-07-03 14:27 ` Michael Ellerman
2 siblings, 0 replies; 4+ messages in thread
From: Michael Ellerman @ 2019-07-03 14:27 UTC (permalink / raw)
To: Qian Cai; +Cc: Qian Cai, sbobroff, linux-kernel, oohall, paulus, linuxppc-dev
On Wed, 2019-06-05 at 20:46:19 UTC, Qian Cai wrote:
> The opening comment mark "/**" is reserved for kernel-doc comments, so
> it will generate a warning with "make W=1".
>
> arch/powerpc/kernel/eeh_cache.c:37: warning: cannot understand function
> prototype: 'struct pci_io_addr_range
>
> Since this is not a kernel-doc for the struct below, but rather an
> overview of this source eeh_cache.c, just use the free-form comments
> kernel-doc syntax instead.
>
> Signed-off-by: Qian Cai <cai@lca.pw>
> Acked-by: Russell Currey <ruscur@russell.cc>
Applied to powerpc next, thanks.
https://git.kernel.org/powerpc/c/3becd11dffe5d4a7467ebd841172f3e091fbcbd0
cheers
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2019-07-03 14:27 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-06-05 20:46 [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning Qian Cai
2019-06-27 19:55 ` Qian Cai
2019-06-28 3:02 ` Russell Currey
2019-07-03 14:27 ` Michael Ellerman
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).