mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
* [PATCH] x86/sgx: fix enum kernel-doc notation
@ 2025-11-15  5:54 Randy Dunlap
  2025-11-16  9:37 ` Huang, Kai
  0 siblings, 1 reply; 2+ messages in thread
From: Randy Dunlap @ 2025-11-15  5:54 UTC (permalink / raw)
  To: linux-kernel; +Cc: Randy Dunlap, Jarkko Sakkinen, Dave Hansen, linux-sgx, x86

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 {

^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re: [PATCH] x86/sgx: fix enum kernel-doc notation
  2025-11-15  5:54 [PATCH] x86/sgx: fix enum kernel-doc notation Randy Dunlap
@ 2025-11-16  9:37 ` Huang, Kai
  0 siblings, 0 replies; 2+ messages in thread
From: Huang, Kai @ 2025-11-16  9:37 UTC (permalink / raw)
  To: rdunlap, linux-kernel; +Cc: linux-sgx, jarkko, dave.hansen, x86

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.

^ permalink raw reply	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2025-11-16  9:37 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2025-11-15  5:54 [PATCH] x86/sgx: fix enum kernel-doc notation Randy Dunlap
2025-11-16  9:37 ` Huang, Kai

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®