linux-kernel - [tip: x86/sgx] x86/sgx: Add a missing colon in kernel-doc markup for "struct sgx_enclave

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-ID: <176316319884.498.5148739863226494963.tip-bot2@tip-bot2>
Date: Fri, 14 Nov 2025 23:33:18 -0000
From: "tip-bot2 for Sean Christopherson" <tip-bot2@...utronix.de>
To: linux-tip-commits@...r.kernel.org
Cc: Stephen Rothwell <sfr@...b.auug.org.au>,
 Sean Christopherson <seanjc@...gle.com>,
 Dave Hansen <dave.hansen@...ux.intel.com>, Kai Huang <kai.huang@...el.com>,
 x86@...nel.org, linux-kernel@...r.kernel.org
Subject: [tip: x86/sgx] x86/sgx: Add a missing colon in kernel-doc markup for
 "struct sgx_enclave_run"

The following commit has been merged into the x86/sgx branch of tip:

Commit-ID:     75801ca620a6ba9f3da7d4e3d3a8ad10811c579e
Gitweb:        https://git.kernel.org/tip/75801ca620a6ba9f3da7d4e3d3a8ad10811c579e
Author:        Sean Christopherson <seanjc@...gle.com>
AuthorDate:    Wed, 12 Nov 2025 08:07:04 -08:00
Committer:     Dave Hansen <dave.hansen@...ux.intel.com>
CommitterDate: Fri, 14 Nov 2025 15:30:13 -08:00

x86/sgx: Add a missing colon in kernel-doc markup for "struct sgx_enclave_run"

Add a missing ':' for the description of sgx_enclave_run.reserved so that
documentation for the member is correctly generated:

  WARNING: arch/x86/include/uapi/asm/sgx.h:184 struct member 'reserved' not
  described in 'sgx_enclave_run'

Closes: https://lore.kernel.org/all/20251106145506.145fc620@canb.auug.org.au
Reported-by: Stephen Rothwell <sfr@...b.auug.org.au>
Signed-off-by: Sean Christopherson <seanjc@...gle.com>
Signed-off-by: Dave Hansen <dave.hansen@...ux.intel.com>
Reviewed-by: Kai Huang <kai.huang@...el.com>
Link: https://patch.msgid.link/20251112160708.1343355-2-seanjc%40google.com
---
 arch/x86/include/uapi/asm/sgx.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h
index 2dd35bb..a438ea4 100644
--- a/arch/x86/include/uapi/asm/sgx.h
+++ b/arch/x86/include/uapi/asm/sgx.h
@@ -166,7 +166,7 @@ typedef int (*sgx_enclave_user_handler_t)(long rdi, long rsi, long rdx,
  * @exception_addr:		The address that triggered the exception
  * @user_handler:		User provided callback run on exception
  * @user_data:			Data passed to the user handler
- * @reserved			Reserved for future extensions
+ * @reserved:			Reserved for future extensions
  *
  * If @user_handler is provided, the handler will be invoked on all return paths
  * of the normal flow.  The user handler may transfer control, e.g. via a