Re: [PATCH] x86/sgx: Fix a W=1 build warning in function comment
From: Jarkko Sakkinen
Date: Tue Aug 27 2024 - 14:21:54 EST
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@xxxxxxxxx>
> ---
> 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@xxxxxxxxxx>
BR, Jarkko