[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <20210330214154.GB120746@darkstar.musicnaut.iki.fi>
Date: Wed, 31 Mar 2021 00:41:54 +0300
From: Aaro Koskinen <aaro.koskinen@....fi>
To: Aditya Srivastava <yashsri421@...il.com>
Cc: linux-kernel@...r.kernel.org, lukas.bulwahn@...il.com,
rdunlap@...radead.org, tony@...mide.com, linux@...linux.org.uk,
linux-kernel-mentees@...ts.linuxfoundation.org,
linux-doc@...r.kernel.org, linux-arm-kernel@...ts.infradead.org,
linux-omap@...r.kernel.org
Subject: Re: [PATCH] ARM: OMAP1: fix incorrect kernel-doc comment syntax in
file
Hi,
On Wed, Mar 31, 2021 at 02:23:30AM +0530, Aditya Srivastava wrote:
> The opening comment mark '/**' is used for highlighting the beginning of
> kernel-doc comments.
> The header for arch/arm/mach-omap1/timer.c follows this syntax, but the
> content inside does not comply with kernel-doc.
>
> This line was probably not meant for kernel-doc parsing, but is parsed
> due to the presence of kernel-doc like comment syntax(i.e, '/**'), which
> causes unexpected warning from kernel-doc:
> "warning: expecting prototype for OMAP1 Dual(). Prototype was for OMAP1610_GPTIMER1_BASE() instead"
>
> Provide a simple fix by replacing this occurrence with general comment
> format, i.e. '/*', to prevent kernel-doc from parsing it.
>
> Signed-off-by: Aditya Srivastava <yashsri421@...il.com>
Acked-by: Aaro Koskinen <aaro.koskinen@....fi>
A.
> ---
> * Applies perfectly on next-20210326
>
> arch/arm/mach-omap1/timer.c | 2 +-
> 1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/arm/mach-omap1/timer.c b/arch/arm/mach-omap1/timer.c
> index 97fc2096b970..0411d5508d63 100644
> --- a/arch/arm/mach-omap1/timer.c
> +++ b/arch/arm/mach-omap1/timer.c
> @@ -1,4 +1,4 @@
> -/**
> +/*
> * OMAP1 Dual-Mode Timers - platform device registration
> *
> * Contains first level initialization routines which internally
> --
> 2.17.1
>
Powered by blists - more mailing lists