linux-kernel - Re: [PATCH] x86/sgx: Fix a W=1 build warning in function 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: <D3QWIH0LVC3D.1J26DP9D7R49T@kernel.org>
Date: Tue, 27 Aug 2024 21:21:47 +0300
From: "Jarkko Sakkinen" <jarkko@...nel.org>
To: "Kai Huang" <kai.huang@...el.com>, <dave.hansen@...el.com>,
 <tglx@...utronix.de>, <bp@...en8.de>, <mingo@...hat.com>, <hpa@...or.com>
Cc: <x86@...nel.org>, <linux-sgx@...r.kernel.org>,
 <linux-kernel@...r.kernel.org>
Subject: Re: [PATCH] x86/sgx: Fix a W=1 build warning in function comment

On Sun Aug 25, 2024 at 11:06 AM EEST, Kai Huang wrote:
> Building the SGX code with W=1 generates below warning:
>
>   arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'low' not described in 'sgx_calc_section_metric'
>   arch/x86/kernel/cpu/sgx/main.c:741: warning: Function parameter or struct member 'high' not described in 'sgx_calc_section_metric'
>   ...
>
> The function sgx_calc_section_metric() is a simple helper which is only
> used in sgx/main.c.  There's no need to use k-doc style comment for it.
>
> Downgrade to normal comment to silence this warning.
>
> Signed-off-by: Kai Huang <kai.huang@...el.com>
> ---
>  arch/x86/kernel/cpu/sgx/main.c | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/arch/x86/kernel/cpu/sgx/main.c b/arch/x86/kernel/cpu/sgx/main.c
> index 27892e57c4ef..1a000acd933a 100644
> --- a/arch/x86/kernel/cpu/sgx/main.c
> +++ b/arch/x86/kernel/cpu/sgx/main.c
> @@ -732,7 +732,7 @@ int arch_memory_failure(unsigned long pfn, int flags)
>  	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.
>
> base-commit: e77f8f275278886d05ce6dfe9e3bc854e7bf0713

Agreed, that has went there probably by plain mistake. Do not think it
has been intentional...

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

BR, Jarkko