Re: [PATCH] x86/sgx: Describe the parameters of sgx_calc_section_metric()

[Jarkko Sakkinen]

On Fri Aug 25, 2023 at 6:18 PM EEST, Dave Hansen wrote:
> On 8/22/23 03:28, Jarkko Sakkinen wrote:
> > Cc: stable@xxxxxxxxxxxxxxx # v5.11+
> > Fixes: e7e0545299d8 ("x86/sgx: Initialize metadata for Enclave Page Cache (EPC) sections")
> > Reported-by: kernel test robot <lkp@xxxxxxxxx>
> > Closes: https://lore.kernel.org/oe-kbuild-all/202308221542.11UpkVfp-lkp@xxxxxxxxx/
> > Signed-off-by: Jarkko Sakkinen <jarkko@xxxxxxxxxx>
>
> -ENOCHANGELOG

ack

> >  /**
> > + * sgx_calc_section_metric() - Calculate an EPC section metric
> > + * @low:	low 32-bit word from CPUID:0x12:{2, ...}
> > + * @high:	high 32-bit word from CPUID:0x12:{2, ...}
> > + *
> >   * 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.
>
> Shouldn't we just do:
>
> -  /**
> +  /*
>
> ?  This doesn't need kerneldoc comments.

Yeah, I added it because of parameter descriptions, which I think are
still useful.

If checkpatch does not complain, I can change the comment type.

BR, Jarkko