Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Message-ID: <1561665339.5154.92.camel@lca.pw>
Subject: Re: [PATCH] powerpc/eeh_cache: fix a W=1 kernel-doc warning
From:   Qian Cai <cai@lca.pw>
To:     mpe@ellerman.id.au
Cc:     ruscur@russell.cc, sbobroff@linux.ibm.com, oohall@gmail.com,
        benh@kernel.crashing.org, paulus@samba.org,
        linuxppc-dev@lists.ozlabs.org, linux-kernel@vger.kernel.org
Date:   Thu, 27 Jun 2019 15:55:39 -0400
In-Reply-To: <1559767579-7151-1-git-send-email-cai@lca.pw>
References: <1559767579-7151-1-git-send-email-cai@lca.pw>
Content-Type: text/plain; charset="UTF-8"
Mime-Version: 1.0
Content-Transfer-Encoding: 8bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

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;