Re: [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning

[Qian Cai]

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@xxxxxx>
> ---
> Â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;