Commit bf594bf4 authored by Alex Shi's avatar Alex Shi Committed by Thomas Gleixner
Browse files

locking/rtmutex: Add missing kernel-doc markup 



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'

[ tglx: Change rt lock to rt_mutex for consistency sake ]

Signed-off-by: default avatarAlex Shi <alex.shi@linux.alibaba.com>
Signed-off-by: default avatarThomas Gleixner <tglx@linutronix.de>
Acked-by: default avatarWill Deacon <will@kernel.org>
Link: https://lore.kernel.org/r/1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com
parent 0f943850

kernel/locking/rtmutex.c

+11 −6
Original line number Diff line number Diff line
@@ -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:	The wake queue head from which to get the next lock waiter

 */

bool __sched __rt_mutex_futex_unlock(struct rt_mutex *lock,

				    struct wake_q_head *wake_q)
@@ -1662,13 +1665,15 @@ void rt_mutex_destroy(struct rt_mutex *lock) 
EXPORT_SYMBOL_GPL(rt_mutex_destroy);



/**

 * __rt_mutex_init - initialize the rt lock

 * __rt_mutex_init - initialize the rt_mutex

 *

 * @lock: the rt lock to be initialized

 * @lock:	The rt_mutex to be initialized

 * @name:	The lock name used for debugging

 * @key:	The lock class key used for debugging

 *

 * Initialize the rt lock to unlocked state.

 * Initialize the rt_mutex to unlocked state.

 *

 * Initializing of a locked rt lock is not allowed

 * Initializing of a locked rt_mutex is not allowed

 */

void __rt_mutex_init(struct rt_mutex *lock, const char *name,

		     struct lock_class_key *key)