linux-kernel - Re: [PATCH v2] x86/sgx: fix kernel-doc comment misuse

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: <CZ3D8KKRVFH4.Y7KBNMB4YXTS@kernel.org>
Date: Mon, 12 Feb 2024 22:00:17 +0200
From: "Jarkko Sakkinen" <jarkko@...nel.org>
To: "Randy Dunlap" <rdunlap@...radead.org>, <linux-kernel@...r.kernel.org>
Cc: "Dave Hansen" <dave.hansen@...ux.intel.com>,
 <linux-sgx@...r.kernel.org>, <x86@...nel.org>, "Kai Huang"
 <kai.huang@...el.com>
Subject: Re: [PATCH v2] x86/sgx: fix kernel-doc comment misuse

On Sun Feb 11, 2024 at 8:24 AM EET, Randy Dunlap wrote:
> Don't use "/**" for a non-kernel-doc comment. This prevents a warning
> from scripts/kernel-doc:
>
> main.c:740: warning: expecting prototype for A section metric is concatenated in a way that @low bits 12(). Prototype was for sgx_calc_section_metric() instead
>
> Cc: Jarkko Sakkinen <jarkko@...nel.org>
> Cc: Dave Hansen <dave.hansen@...ux.intel.com>
> Cc: linux-sgx@...r.kernel.org
> Cc: x86@...nel.org
> Reviewed-by: Kai Huang <kai.huang@...el.com>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> ---
> v2: add Rev-by: Kai Huang
>
>  arch/x86/kernel/cpu/sgx/main.c |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff -- a/arch/x86/kernel/cpu/sgx/main.c b/arch/x86/kernel/cpu/sgx/main.c
> --- a/arch/x86/kernel/cpu/sgx/main.c
> +++ b/arch/x86/kernel/cpu/sgx/main.c
> @@ -731,7 +731,7 @@ out:
>  	return 0;
>  }
>  
> -/**
> +/*
>   * A section metric is concatenated in a way that @low bits 12-31 define the
>   * bits 12-31 of the metric and @high bits 0-19 define the bits 32-51 of the
>   * metric.


Reviewed-by: Jarkko Sakkinen <jarkko@...nel.org>

BR, Jarkko