Skip to contentSkip to conversation

x86/sgx: fix doc warning

PATCH Applied ChenXiaoSong 2 participants 2 messages Jun 9, 2021 – Jun 11, 2021

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 x86/sgx: fix doc warning

Fix gcc W=1 warning:

arch/x86/kernel/cpu/sgx/encl.c:392: warning: Function parameter or member 'ref' not described in 'sgx_encl_release'

---
 arch/x86/kernel/cpu/sgx/encl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kernel/cpu/sgx/encl.c +1 -1
index 3be203297988..001808e3901c 100644
@@ -383,7 +383,7 @@ const struct vm_operations_struct sgx_vm_ops = {
 
 /**
  * sgx_encl_release - Destroy an enclave instance
- * @kref:	address of a kref inside &sgx_encl
+ * @ref:	address of a kref inside &sgx_encl
  *
  * Used together with kref_put(). Frees all the resources associated with the
  * enclave and the instance itself.
Signature · 1 line
2.25.4
merge bot Applied
#1 lore raw

[tip: x86/cleanups] x86/sgx: Correct kernel-doc's arg name in sgx_encl_release()

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

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

Commit-ID:     1d3156396cf6ea0873145092f4e040374ff1d862
Gitweb:        https://git.kernel.org/tip/1d3156396cf6ea0873145092f4e040374ff1d862
Author:        ChenXiaoSong <[email protected]>
AuthorDate:    Wed, 09 Jun 2021 11:55:10 +08:00
Committer:     Borislav Petkov <[email protected]>
CommitterDate: Fri, 11 Jun 2021 10:42:38 +02:00

x86/sgx: Correct kernel-doc's arg name in sgx_encl_release()

Fix the following kernel-doc warning:

arch/x86/kernel/cpu/sgx/encl.c:392: warning: Function parameter \
or member 'ref' not described in 'sgx_encl_release'

[ bp: Massage commit message. ]

---
 arch/x86/kernel/cpu/sgx/encl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kernel/cpu/sgx/encl.c +1 -1
index 3be2032..001808e 100644
@@ -383,7 +383,7 @@ const struct vm_operations_struct sgx_vm_ops = {
 
 /**
  * sgx_encl_release - Destroy an enclave instance
- * @kref:	address of a kref inside &sgx_encl
+ * @ref:	address of a kref inside &sgx_encl
  *
  * Used together with kref_put(). Frees all the resources associated with the
  * enclave and the instance itself.