| Message ID | 1559767579-7151-1-git-send-email-cai@lca.pw (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 3becd11dffe5d4a7467ebd841172f3e091fbcbd0 |
| Headers | show |
| Series | powerpc/eeh_cache: fix a W=1 kernel-doc warning | expand |
| Context | Check | Description |
|---|---|---|
| snowpatch_ozlabs/apply_patch | success | Successfully applied on branch next (a3bf9fbdad600b1e4335dd90979f8d6072e4f602) |
| snowpatch_ozlabs/build-ppc64le | success | Build succeeded |
| snowpatch_ozlabs/build-ppc64be | success | Build succeeded |
| snowpatch_ozlabs/build-ppc64e | success | Build succeeded |
| snowpatch_ozlabs/build-pmac32 | success | Build succeeded |
| snowpatch_ozlabs/checkpatch | success | total: 0 errors, 0 warnings, 0 checks, 15 lines checked |
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;
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>
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
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;
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(+)