[PATCH v2 1/1] local_lock: Minor improvements of local_trylock*() documentation

[PATCH v2 1/1] local_lock: Minor improvements of local_trylock*() documentation

[Leonardo Bras]

Fix local_trylock_init() documentation, as it was mentioning the non-try
helper instead, and use the opportunity to make clear the try_lock*() needs
to receive a local_trylock_t variable as parameter.

Signed-off-by: Leonardo Bras <leobras@redhat.com>
---
v1: https://lore.kernel.org/all/20250505170244.253170-1-leobras@redhat.com/
RFC: https://lore.kernel.org/all/20250430073610.163846-1-leobras@redhat.com/


 include/linux/local_lock.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/linux/local_lock.h b/include/linux/local_lock.h
index 16a2ee4f8310b..d8d5e6cfa1151 100644
--- a/include/linux/local_lock.h
+++ b/include/linux/local_lock.h
@@ -45,38 +45,38 @@
 /**
  * local_unlock_irqrestore - Release a per CPU local lock and restore
  *			      interrupt flags
  * @lock:	The lock variable
  * @flags:      Interrupt flags to restore
  */
 #define local_unlock_irqrestore(lock, flags)			\
 	__local_unlock_irqrestore(lock, flags)
 
 /**
- * local_lock_init - Runtime initialize a lock instance
+ * local_trylock_init - Runtime initialize a local_trylock_t instance
  */
 #define local_trylock_init(lock)	__local_trylock_init(lock)
 
 /**
  * local_trylock - Try to acquire a per CPU local lock
- * @lock:	The lock variable
+ * @lock:	The local_trylock_t variable
  *
  * The function can be used in any context such as NMI or HARDIRQ. Due to
  * locking constrains it will _always_ fail to acquire the lock in NMI or
  * HARDIRQ context on PREEMPT_RT.
  */
 #define local_trylock(lock)		__local_trylock(lock)
 
 /**
  * local_trylock_irqsave - Try to acquire a per CPU local lock, save and disable
  *			   interrupts if acquired
- * @lock:	The lock variable
+ * @lock:	The local_trylock_t variable
  * @flags:	Storage for interrupt flags
  *
  * The function can be used in any context such as NMI or HARDIRQ. Due to
  * locking constrains it will _always_ fail to acquire the lock in NMI or
  * HARDIRQ context on PREEMPT_RT.
  */
 #define local_trylock_irqsave(lock, flags)			\
 	__local_trylock_irqsave(lock, flags)
 
 DEFINE_GUARD(local_lock, local_lock_t __percpu*,
-- 
2.49.0

Re: [PATCH v2 1/1] local_lock: Minor improvements of local_trylock*() documentation

[Vlastimil Babka]

On 5/21/25 19:47, Leonardo Bras wrote:
> Fix local_trylock_init() documentation, as it was mentioning the non-try
> helper instead, and use the opportunity to make clear the try_lock*() needs
> to receive a local_trylock_t variable as parameter.
> 
> Signed-off-by: Leonardo Bras <leobras@redhat.com>

Acked-by: Vlastimil Babka <vbabka@suse.cz>

Locking tree (btw the local_lock files are missing in the list of
MAINTAINERS) or mm since this fixes up changes that went through mm recently?

> ---
> v1: https://lore.kernel.org/all/20250505170244.253170-1-leobras@redhat.com/
> RFC: https://lore.kernel.org/all/20250430073610.163846-1-leobras@redhat.com/
> 
> 
>  include/linux/local_lock.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/linux/local_lock.h b/include/linux/local_lock.h
> index 16a2ee4f8310b..d8d5e6cfa1151 100644
> --- a/include/linux/local_lock.h
> +++ b/include/linux/local_lock.h
> @@ -45,38 +45,38 @@
>  /**
>   * local_unlock_irqrestore - Release a per CPU local lock and restore
>   *			      interrupt flags
>   * @lock:	The lock variable
>   * @flags:      Interrupt flags to restore
>   */
>  #define local_unlock_irqrestore(lock, flags)			\
>  	__local_unlock_irqrestore(lock, flags)
>  
>  /**
> - * local_lock_init - Runtime initialize a lock instance
> + * local_trylock_init - Runtime initialize a local_trylock_t instance
>   */
>  #define local_trylock_init(lock)	__local_trylock_init(lock)
>  
>  /**
>   * local_trylock - Try to acquire a per CPU local lock
> - * @lock:	The lock variable
> + * @lock:	The local_trylock_t variable
>   *
>   * The function can be used in any context such as NMI or HARDIRQ. Due to
>   * locking constrains it will _always_ fail to acquire the lock in NMI or
>   * HARDIRQ context on PREEMPT_RT.
>   */
>  #define local_trylock(lock)		__local_trylock(lock)
>  
>  /**
>   * local_trylock_irqsave - Try to acquire a per CPU local lock, save and disable
>   *			   interrupts if acquired
> - * @lock:	The lock variable
> + * @lock:	The local_trylock_t variable
>   * @flags:	Storage for interrupt flags
>   *
>   * The function can be used in any context such as NMI or HARDIRQ. Due to
>   * locking constrains it will _always_ fail to acquire the lock in NMI or
>   * HARDIRQ context on PREEMPT_RT.
>   */
>  #define local_trylock_irqsave(lock, flags)			\
>  	__local_trylock_irqsave(lock, flags)
>  
>  DEFINE_GUARD(local_lock, local_lock_t __percpu*,