linux-kernel - Re: [PATCH] locking/rtmutex: Use struct keyword in kernel-doc comment

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]

Message-ID: <73fc5150-ecfe-4dbc-8188-acb818c1cfa2@redhat.com>
Date: Sun, 12 Jan 2025 22:28:01 -0500
From: Waiman Long <llong@...hat.com>
To: Randy Dunlap <rdunlap@...radead.org>, linux-kernel@...r.kernel.org
Cc: Peter Zijlstra <peterz@...radead.org>, Ingo Molnar <mingo@...hat.com>,
 Will Deacon <will@...nel.org>, Boqun Feng <boqun.feng@...il.com>
Subject: Re: [PATCH] locking/rtmutex: Use struct keyword in kernel-doc comment

On 1/11/25 1:30 AM, Randy Dunlap wrote:
> Add the "struct" keyword to prevent a kernel-doc warning:
>
> rtmutex_common.h:67: warning: cannot understand function prototype: 'struct rt_wake_q_head '
>
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Cc: Peter Zijlstra <peterz@...radead.org>
> Cc: Ingo Molnar <mingo@...hat.com>
> Cc: Will Deacon <will@...nel.org>
> Cc: Waiman Long <longman@...hat.com>
> Cc: Boqun Feng <boqun.feng@...il.com>
> ---
>   kernel/locking/rtmutex_common.h |    4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
>
> --- linux-next-20250108.orig/kernel/locking/rtmutex_common.h
> +++ linux-next-20250108/kernel/locking/rtmutex_common.h
> @@ -59,8 +59,8 @@ struct rt_mutex_waiter {
>   };
>   
>   /**
> - * rt_wake_q_head - Wrapper around regular wake_q_head to support
> - *		    "sleeping" spinlocks on RT
> + * struct rt_wake_q_head - Wrapper around regular wake_q_head to support
> + *			   "sleeping" spinlocks on RT
>    * @head:		The regular wake_q_head for sleeping lock variants
>    * @rtlock_task:	Task pointer for RT lock (spin/rwlock) wakeups
>    */
>
Acked-by: Waiman Long <longman@...hat.com>