linux-kernel - [tip: x86/cleanups] x86/sgx: Correct kernel-doc's arg name in sgx_encl

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>] [<thread-prev] [day] [month] [year] [list]

Date:   Fri, 11 Jun 2021 08:46:51 -0000
From:   "tip-bot2 for ChenXiaoSong" <tip-bot2@...utronix.de>
To:     linux-tip-commits@...r.kernel.org
Cc:     ChenXiaoSong <chenxiaosong2@...wei.com>,
        Borislav Petkov <bp@...e.de>, x86@...nel.org,
        linux-kernel@...r.kernel.org
Subject: [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:

Commit-ID:     1d3156396cf6ea0873145092f4e040374ff1d862
Gitweb:        https://git.kernel.org/tip/1d3156396cf6ea0873145092f4e040374ff1d862
Author:        ChenXiaoSong <chenxiaosong2@...wei.com>
AuthorDate:    Wed, 09 Jun 2021 11:55:10 +08:00
Committer:     Borislav Petkov <bp@...e.de>
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. ]

Signed-off-by: ChenXiaoSong <chenxiaosong2@...wei.com>
Signed-off-by: Borislav Petkov <bp@...e.de>
Link: https://lkml.kernel.org/r/20210609035510.2083694-1-chenxiaosong2@huawei.com
---
 arch/x86/kernel/cpu/sgx/encl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/arch/x86/kernel/cpu/sgx/encl.c b/arch/x86/kernel/cpu/sgx/encl.c
index 3be2032..001808e 100644
--- a/arch/x86/kernel/cpu/sgx/encl.c
+++ b/arch/x86/kernel/cpu/sgx/encl.c
@@ -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.