[PATCH 5/5] x86/sgx: Fix a typo in the kernel-doc comment for enum sgx_attribute

Sean Christopherson posted 5 patches 2 months, 4 weeks ago
[PATCH 5/5] x86/sgx: Fix a typo in the kernel-doc comment for enum sgx_attribute
Posted by Sean Christopherson 2 months, 4 weeks ago
Use the exact enum name when documenting "enum sgx_attribute" to fix a
warning if the file is fed into kernel-doc processing:

  WARNING: ./arch/x86/include/asm/sgx.h:139 expecting prototype for enum
           sgx_attributes. Prototype was for enum sgx_attribute instead

Signed-off-by: Sean Christopherson <seanjc@google.com>
---
 arch/x86/include/asm/sgx.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/include/asm/sgx.h b/arch/x86/include/asm/sgx.h
index 3c90cae04e1d..04958459a7ca 100644
--- a/arch/x86/include/asm/sgx.h
+++ b/arch/x86/include/asm/sgx.h
@@ -112,7 +112,7 @@ enum sgx_miscselect {
 #define SGX_SSA_MISC_EXINFO_SIZE	16
 
 /**
- * enum sgx_attributes - the attributes field in &struct sgx_secs
+ * enum sgx_attribute - the attributes field in &struct sgx_secs
  * @SGX_ATTR_INIT:		Enclave can be entered (is initialized).
  * @SGX_ATTR_DEBUG:		Allow ENCLS(EDBGRD) and ENCLS(EDBGWR).
  * @SGX_ATTR_MODE64BIT:		Tell that this a 64-bit enclave.
-- 
2.51.2.1041.gc1ab5b90ca-goog
Re: [PATCH 5/5] x86/sgx: Fix a typo in the kernel-doc comment for enum sgx_attribute
Posted by Jarkko Sakkinen 2 months, 3 weeks ago
On Wed, Nov 12, 2025 at 08:07:08AM -0800, Sean Christopherson wrote:
> Use the exact enum name when documenting "enum sgx_attribute" to fix a
> warning if the file is fed into kernel-doc processing:
> 
>   WARNING: ./arch/x86/include/asm/sgx.h:139 expecting prototype for enum
>            sgx_attributes. Prototype was for enum sgx_attribute instead
> 
> Signed-off-by: Sean Christopherson <seanjc@google.com>
> ---
>  arch/x86/include/asm/sgx.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/arch/x86/include/asm/sgx.h b/arch/x86/include/asm/sgx.h
> index 3c90cae04e1d..04958459a7ca 100644
> --- a/arch/x86/include/asm/sgx.h
> +++ b/arch/x86/include/asm/sgx.h
> @@ -112,7 +112,7 @@ enum sgx_miscselect {
>  #define SGX_SSA_MISC_EXINFO_SIZE	16
>  
>  /**
> - * enum sgx_attributes - the attributes field in &struct sgx_secs
> + * enum sgx_attribute - the attributes field in &struct sgx_secs
>   * @SGX_ATTR_INIT:		Enclave can be entered (is initialized).
>   * @SGX_ATTR_DEBUG:		Allow ENCLS(EDBGRD) and ENCLS(EDBGWR).
>   * @SGX_ATTR_MODE64BIT:		Tell that this a 64-bit enclave.
> -- 
> 2.51.2.1041.gc1ab5b90ca-goog
> 

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

BR, Jarkko