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

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

[Jarkko Sakkinen]

Cc: stable@vger.kernel.org # v5.11+
Fixes: e7e0545299d8 ("x86/sgx: Initialize metadata for Enclave Page Cache (EPC) sections")
Reported-by: kernel test robot <lkp@intel.com>
Closes: https://lore.kernel.org/oe-kbuild-all/202308221542.11UpkVfp-lkp@intel.com/
Signed-off-by: Jarkko Sakkinen <jarkko@kernel.org>
---
 arch/x86/kernel/cpu/sgx/main.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/arch/x86/kernel/cpu/sgx/main.c b/arch/x86/kernel/cpu/sgx/main.c
index 166692f2d501..388350b8f5e3 100644
--- a/arch/x86/kernel/cpu/sgx/main.c
+++ b/arch/x86/kernel/cpu/sgx/main.c
@@ -732,6 +732,10 @@ int arch_memory_failure(unsigned long pfn, int flags)
 }
 
 /**
+ * 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.
-- 
2.39.2

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

[Dave Hansen]

On 8/22/23 03:28, Jarkko Sakkinen wrote:
> Cc: stable@vger.kernel.org # v5.11+
> Fixes: e7e0545299d8 ("x86/sgx: Initialize metadata for Enclave Page Cache (EPC) sections")
> Reported-by: kernel test robot <lkp@intel.com>
> Closes: https://lore.kernel.org/oe-kbuild-all/202308221542.11UpkVfp-lkp@intel.com/
> Signed-off-by: Jarkko Sakkinen <jarkko@kernel.org>

-ENOCHANGELOG

>  /**
> + * 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.

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@vger.kernel.org # v5.11+
> > Fixes: e7e0545299d8 ("x86/sgx: Initialize metadata for Enclave Page Cache (EPC) sections")
> > Reported-by: kernel test robot <lkp@intel.com>
> > Closes: https://lore.kernel.org/oe-kbuild-all/202308221542.11UpkVfp-lkp@intel.com/
> > Signed-off-by: Jarkko Sakkinen <jarkko@kernel.org>
>
> -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