[PATCH] dma-fence: correct kernel-doc function parameter @flags

[PATCH] dma-fence: correct kernel-doc function parameter @flags

[Randy Dunlap]

'make htmldocs' complains that dma_fence_unlock_irqrestore() is missing
a description of its @flags parameter. The description is there but it is
missing a ':' sign. Add that and correct the possessive form of "its".

WARNING: ../include/linux/dma-fence.h:414 function parameter 'flags' not described in 'dma_fence_unlock_irqrestore'

Fixes: 3e5067931b5d ("dma-buf: abstract fence locking v2")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
---
Cc: Christian König <christian.koenig@amd.com>
Cc: Sumit Semwal <sumit.semwal@linaro.org>
Cc: linux-media@vger.kernel.org

 include/linux/dma-fence.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260406.orig/include/linux/dma-fence.h
+++ linux-next-20260406/include/linux/dma-fence.h
@@ -408,9 +408,9 @@ static inline spinlock_t *dma_fence_spin
 /**
  * dma_fence_unlock_irqrestore - unlock the fence and irqrestore
  * @fence: the fence to unlock
- * @flags the CPU flags to restore
+ * @flags: the CPU flags to restore
  *
- * Unlock the fence, allowing it to change it's state to signaled again.
+ * Unlock the fence, allowing it to change its state to signaled again.
  */
 #define dma_fence_unlock_irqrestore(fence, flags)	\
 	spin_unlock_irqrestore(dma_fence_spinlock(fence), flags)

Re: [PATCH] dma-fence: correct kernel-doc function parameter @flags

[Christian König]

On 4/7/26 06:36, Randy Dunlap wrote:
> 'make htmldocs' complains that dma_fence_unlock_irqrestore() is missing
> a description of its @flags parameter. The description is there but it is
> missing a ':' sign. Add that and correct the possessive form of "its".
> 
> WARNING: ../include/linux/dma-fence.h:414 function parameter 'flags' not described in 'dma_fence_unlock_irqrestore'
> 
> Fixes: 3e5067931b5d ("dma-buf: abstract fence locking v2")
> Signed-off-by: Randy Dunlap <rdunlap@infradead.org>

Reviewed-by: Christian König <christian.koenig@amd.com>

Going to push it later today.

> ---
> Cc: Christian König <christian.koenig@amd.com>
> Cc: Sumit Semwal <sumit.semwal@linaro.org>
> Cc: linux-media@vger.kernel.org
> 
>  include/linux/dma-fence.h |    4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> --- linux-next-20260406.orig/include/linux/dma-fence.h
> +++ linux-next-20260406/include/linux/dma-fence.h
> @@ -408,9 +408,9 @@ static inline spinlock_t *dma_fence_spin
>  /**
>   * dma_fence_unlock_irqrestore - unlock the fence and irqrestore
>   * @fence: the fence to unlock
> - * @flags the CPU flags to restore
> + * @flags: the CPU flags to restore
>   *
> - * Unlock the fence, allowing it to change it's state to signaled again.
> + * Unlock the fence, allowing it to change its state to signaled again.
>   */
>  #define dma_fence_unlock_irqrestore(fence, flags)	\
>  	spin_unlock_irqrestore(dma_fence_spinlock(fence), flags)