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

[PATCH v1 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>
---

Changes since RFC:
- Replace try-enabled lock with local_trylock{,_t}

 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..58adaaf98dd74 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 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 v1 1/1] local_lock: Minor improvements of local_trylock*() documentation

[Sebastian Andrzej Siewior]

On 2025-05-05 14:02:44 [-0300], 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>
…
> --- 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 instance

If you replace "lock instance" please use local_trylock_t instead
"local_trylock"

Other than that,
Reviewed-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>

>   */
>  #define local_trylock_init(lock)	__local_trylock_init(lock)

…

Sebastian

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

[Leonardo Bras Soares Passos]

Hi Sebastian,

On Mon, May 12, 2025 at 7:43 AM Sebastian Andrzej Siewior
<bigeasy@linutronix.de> wrote:
>
> On 2025-05-05 14:02:44 [-0300], 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>
> …
> > --- 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 instance
>
> If you replace "lock instance" please use local_trylock_t instead
> "local_trylock"

Will do

>
> Other than that,
> Reviewed-by: Sebastian Andrzej Siewior <bigeasy@linutronix.de>

Thanks!
Leo

>
> >   */
> >  #define local_trylock_init(lock)     __local_trylock_init(lock)
>
> …
>
> Sebastian
>