locking/rtmutex: Use struct keyword in kernel-doc comment

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

Posted by Randy Dunlap 1 year ago

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@infradead.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>
Cc: Waiman Long <longman@redhat.com>
Cc: Boqun Feng <boqun.feng@gmail.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
  */

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

Posted by Waiman Long 1 year ago

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@infradead.org>
> Cc: Peter Zijlstra <peterz@infradead.org>
> Cc: Ingo Molnar <mingo@redhat.com>
> Cc: Will Deacon <will@kernel.org>
> Cc: Waiman Long <longman@redhat.com>
> Cc: Boqun Feng <boqun.feng@gmail.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@redhat.com>

[tip: locking/core] locking/rtmutex: Use struct keyword in kernel-doc comment

Posted by tip-bot2 for Randy Dunlap 11 months, 1 week ago

The following commit has been merged into the locking/core branch of tip:

Commit-ID:     5ddd09863c676935c18c8a13f5afb6d9992cbdeb
Gitweb:        https://git.kernel.org/tip/5ddd09863c676935c18c8a13f5afb6d9992cbdeb
Author:        Randy Dunlap <rdunlap@infradead.org>
AuthorDate:    Fri, 10 Jan 2025 22:30:40 -08:00
Committer:     Boqun Feng <boqun.feng@gmail.com>
CommitterDate: Sun, 23 Feb 2025 18:24:46 -08:00

locking/rtmutex: Use struct keyword in kernel-doc comment

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@infradead.org>
Cc: Peter Zijlstra <peterz@infradead.org>
Cc: Ingo Molnar <mingo@redhat.com>
Cc: Will Deacon <will@kernel.org>
Cc: Waiman Long <longman@redhat.com>
Cc: Boqun Feng <boqun.feng@gmail.com>
Acked-by: Waiman Long <longman@redhat.com>
Signed-off-by: Boqun Feng <boqun.feng@gmail.com>
Link: https://lore.kernel.org/r/20250111063040.910763-1-rdunlap@infradead.org
---
 kernel/locking/rtmutex_common.h | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/kernel/locking/rtmutex_common.h b/kernel/locking/rtmutex_common.h
index c38a2d2..78dd3d8 100644
--- a/kernel/locking/rtmutex_common.h
+++ b/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
  */