[PATCH] x86/sgx: fix enum kernel-doc notation

Randy Dunlap posted 1 patch 2 months, 3 weeks ago
arch/x86/include/uapi/asm/sgx.h |    2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
[PATCH] x86/sgx: fix enum kernel-doc notation
Posted by Randy Dunlap 2 months, 3 weeks ago
Use "@name" instead of "%name" to describe members of an enum. This
prevents a kernel-doc warning:

WARNING: arch/x86/include/uapi/asm/sgx.h:17 Enum value
 'SGX_PAGE_MEASURE' not described in enum 'sgx_page_flags'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Jarkko Sakkinen <jarkko@kernel.org>
Cc: Dave Hansen <dave.hansen@linux.intel.com>
Cc: linux-sgx@vger.kernel.org
Cc: x86@kernel.org
---
 arch/x86/include/uapi/asm/sgx.h |    2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

--- linux-next-20251114.orig/arch/x86/include/uapi/asm/sgx.h
+++ linux-next-20251114/arch/x86/include/uapi/asm/sgx.h
@@ -10,7 +10,7 @@
 
 /**
  * enum sgx_page_flags - page control flags
- * %SGX_PAGE_MEASURE:	Measure the page contents with a sequence of
+ * @SGX_PAGE_MEASURE:	Measure the page contents with a sequence of
  *			ENCLS[EEXTEND] operations.
  */
 enum sgx_page_flags {
Re: [PATCH] x86/sgx: fix enum kernel-doc notation
Posted by Huang, Kai 2 months, 3 weeks ago
On Fri, 2025-11-14 at 21:54 -0800, Randy Dunlap wrote:
> Use "@name" instead of "%name" to describe members of an enum. This
> prevents a kernel-doc warning:
> 
> WARNING: arch/x86/include/uapi/asm/sgx.h:17 Enum value
>  'SGX_PAGE_MEASURE' not described in enum 'sgx_page_flags'
> 
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
> ---
> Cc: Jarkko Sakkinen <jarkko@kernel.org>
> Cc: Dave Hansen <dave.hansen@linux.intel.com>
> Cc: linux-sgx@vger.kernel.org
> Cc: x86@kernel.org
> ---
>  arch/x86/include/uapi/asm/sgx.h |    2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> --- linux-next-20251114.orig/arch/x86/include/uapi/asm/sgx.h
> +++ linux-next-20251114/arch/x86/include/uapi/asm/sgx.h
> @@ -10,7 +10,7 @@
>  
>  /**
>   * enum sgx_page_flags - page control flags
> - * %SGX_PAGE_MEASURE:	Measure the page contents with a sequence of
> + * @SGX_PAGE_MEASURE:	Measure the page contents with a sequence of
>   *			ENCLS[EEXTEND] operations.
>   */
>  enum sgx_page_flags {

This has been addressed in Sean's patch:

https://lore.kernel.org/linux-sgx/20251112160708.1343355-4-seanjc@google.com/

And it has been merged to tip tree.