linux-kernel - Re: [PATCH] ARM: s3c24xx: demote kerneldoc comment

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <4c8c1fe5-6212-57eb-7644-174ace5d3622@infradead.org>
Date:   Sun, 2 Aug 2020 13:42:31 -0700
From:   Randy Dunlap <rdunlap@...radead.org>
To:     Krzysztof Kozlowski <krzk@...nel.org>,
        Kukjin Kim <kgene@...nel.org>,
        Russell King <linux@...linux.org.uk>,
        linux-arm-kernel@...ts.infradead.org,
        linux-samsung-soc@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH] ARM: s3c24xx: demote kerneldoc comment

On 8/2/20 1:36 PM, Krzysztof Kozlowski wrote:
> Remove kerneldoc annotation to fix warning:
> 
>     arch/arm/mach-s3c24xx/mach-h1940.c:185: warning:
>         cannot understand function prototype: 'struct s3c2410fb_display h1940_lcd __initdata = '
> 
> Signed-off-by: Krzysztof Kozlowski <krzk@...nel.org>
> ---
>  arch/arm/mach-s3c24xx/mach-h1940.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/arch/arm/mach-s3c24xx/mach-h1940.c b/arch/arm/mach-s3c24xx/mach-h1940.c
> index 89528bea89f1..c09f61d35d57 100644
> --- a/arch/arm/mach-s3c24xx/mach-h1940.c
> +++ b/arch/arm/mach-s3c24xx/mach-h1940.c
> @@ -179,9 +179,9 @@ static struct s3c2410_ts_mach_info h1940_ts_cfg __initdata = {
>  		.cfg_gpio = s3c24xx_ts_cfg_gpio,
>  };
>  
> -/**
> +/*
>   * Set lcd on or off
> - **/
> + */

Yes, that's not kernel-doc notation, so demote it.
Acked-by: Randy Dunlap <rdunlap@...radead.org>


OTOH, we could also add "__initdata" to something that can be
handled by scripts/kernel-doc if it's needed, but it doesn't seem to
be needed just yet.

>  static struct s3c2410fb_display h1940_lcd __initdata = {
>  	.lcdcon5=	S3C2410_LCDCON5_FRM565 | \
>  			S3C2410_LCDCON5_INVVLINE | \
> 

thanks.
-- 
~Randy