[for_v37] x86/sgx: Properly describe vdso_sgx_enter_enclave_t to fix kdoc warning

Commit Message

Sean Christopherson Sept. 4, 2020, 3:38 p.m. UTC

Describe the vdso_sgx_enter_enclave_t typedef instead of the backing
__vdso_sgx_enter_enclave() in the kernel-doc comment for the typedef to
fix a kernel-doc warning.

Opportunistically add a missing asterisk to fix a second warning.

Signed-off-by: Sean Christopherson <[e-mail]>
---
 arch/x86/include/uapi/asm/sgx.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

Patch

diff --git a/arch/x86/include/uapi/asm/sgx.h b/arch/x86/include/uapi/asm/sgx.h
index b1d63f90ad64..b3d5ccf5b976 100644
--- a/arch/x86/include/uapi/asm/sgx.h
+++ b/arch/x86/include/uapi/asm/sgx.h
@@ -145,7 +145,9 @@  struct sgx_enclave_run {
 };
 
 /**
- * __vdso_sgx_enter_enclave() - Enter an SGX enclave
+ * typedef vdso_sgx_enter_enclave_t - Prototype for __vdso_sgx_enter_enclave(),
+ *				      a vDSO function to enter an SGX enclave.
+ *
  * @rdi:	Pass-through value for RDI
  * @rsi:	Pass-through value for RSI
  * @rdx:	Pass-through value for RDX
@@ -177,7 +179,7 @@  struct sgx_enclave_run {
  * never fixed up and are always delivered via standard signals. On synchrously
  * reported exceptions, -EFAULT is returned and details about the exception are
  * recorded in @e, the optional sgx_enclave_exception struct.
-
+ *
  * If an exit handler is provided, the handler will be invoked on synchronous
  * exits from the enclave and for all synchronously reported exceptions. In
  * latter case, @e is filled prior to invoking the handler.