From: Alex Shi <alex.shi@linux.alibaba.com>
To: unlisted-recipients:; (no To-header on input)
Cc: Peter Zijlstra <peterz@infradead.org>,
Ingo Molnar <mingo@redhat.com>, Will Deacon <will@kernel.org>,
linux-kernel@vger.kernel.org
Subject: [PATCH] locking/rtmutex: add missed kernel-doc markup
Date: Fri, 13 Nov 2020 16:58:11 +0800 [thread overview]
Message-ID: <1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com> (raw)
In-Reply-To: <1605257895-5536-1-git-send-email-alex.shi@linux.alibaba.com>
To fix the following issues:
kernel/locking/rtmutex.c:1612: warning: Function parameter or member
'lock' not described in '__rt_mutex_futex_unlock'
kernel/locking/rtmutex.c:1612: warning: Function parameter or member
'wake_q' not described in '__rt_mutex_futex_unlock'
kernel/locking/rtmutex.c:1675: warning: Function parameter or member
'name' not described in '__rt_mutex_init'
kernel/locking/rtmutex.c:1675: warning: Function parameter or member
'key' not described in '__rt_mutex_init'
Signed-off-by: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>
Cc: linux-kernel@vger.kernel.org
---
kernel/locking/rtmutex.c | 9 +++++++--
1 file changed, 7 insertions(+), 2 deletions(-)
diff --git a/kernel/locking/rtmutex.c b/kernel/locking/rtmutex.c
index cfdd5b93264d..50fa521fe767 100644
--- a/kernel/locking/rtmutex.c
+++ b/kernel/locking/rtmutex.c
@@ -1604,8 +1604,11 @@ void __sched rt_mutex_unlock(struct rt_mutex *lock)
EXPORT_SYMBOL_GPL(rt_mutex_unlock);
/**
- * Futex variant, that since futex variants do not use the fast-path, can be
- * simple and will not need to retry.
+ * __rt_mutex_futex_unlock - Futex variant, that since futex variants
+ * do not use the fast-path, can be simple and will not need to retry.
+ *
+ * @lock: the rt_mutex to be unlocked
+ * @wake_q: wake queue head from which get the next lock waiter
*/
bool __sched __rt_mutex_futex_unlock(struct rt_mutex *lock,
struct wake_q_head *wake_q)
@@ -1665,6 +1668,8 @@ EXPORT_SYMBOL_GPL(rt_mutex_destroy);
* __rt_mutex_init - initialize the rt lock
*
* @lock: the rt lock to be initialized
+ * @name: the lock name used for debug
+ * @key: the lock class key used for debug
*
* Initialize the rt lock to unlocked state.
*
--
2.29.GIT
next prev parent reply other threads:[~2020-11-13 8:58 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-13 8:58 [PATCH] PM / suspend: fix kernel-doc markup Alex Shi
2020-11-13 8:58 ` Alex Shi [this message]
2021-01-12 13:28 ` [PATCH] locking/rtmutex: add missed " Will Deacon
2021-01-27 19:31 ` [tip: locking/core] locking/rtmutex: Add missing " tip-bot2 for Alex Shi
2021-01-28 12:21 ` tip-bot2 for Alex Shi
2020-11-13 8:58 ` [PATCH] locking/rtmutex: remove useless parameter for rt_mutex_proxy_unlock Alex Shi
2021-01-12 13:31 ` Will Deacon
2020-11-13 8:58 ` [PATCH] configfs: fix kernel-doc markup issue Alex Shi
2020-11-14 9:26 ` Christoph Hellwig
2020-11-13 8:58 ` [PATCH] x86/PCI: fix a comments issue Alex Shi
2020-11-27 13:06 ` [tip: x86/cleanups] x86/PCI: Make a kernel-doc comment a normal one tip-bot2 for Alex Shi
2020-11-13 8:58 ` [PATCH] PKCS#7: drop function from kernel-doc pkcs7_validate_trust_one Alex Shi
2020-11-23 17:26 ` [PATCH] PM / suspend: fix kernel-doc markup Rafael J. Wysocki
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com \
--to=alex.shi@linux.alibaba.com \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@redhat.com \
--cc=peterz@infradead.org \
--cc=will@kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).