Re: [PATCH] locking/rtmutex: add missed kernel-doc markup

From: Will Deacon <will@kernel.org>
To: Alex Shi <alex.shi@linux.alibaba.com>
Cc: Peter Zijlstra <peterz@infradead.org>,
	Ingo Molnar <mingo@redhat.com>,
	linux-kernel@vger.kernel.org
Subject: Re: [PATCH] locking/rtmutex: add missed kernel-doc markup
Date: Tue, 12 Jan 2021 13:28:22 +0000	[thread overview]
Message-ID: <20210112132821.GA9087@willie-the-truck> (raw)
In-Reply-To: <1605257895-5536-2-git-send-email-alex.shi@linux.alibaba.com>

On Fri, Nov 13, 2020 at 04:58:11PM +0800, Alex Shi wrote:
> 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

missing word: from which *to* get

With that fixed,

Acked-by: Will Deacon <will@kernel.org>

Will