[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)

Claude review: dma-fence: correct kernel-doc function parameter @flags

[Claude Code Review Bot]

Patch Review

**Status: Correct but already applied**

The patch makes two changes:

1. **Missing colon in kernel-doc `@flags` tag:**
```diff
- * @flags the CPU flags to restore
+ * @flags: the CPU flags to restore
```
This is a valid fix. Kernel-doc requires the `@param:` format with a colon; without it, `make htmldocs` emits the warning cited in the commit message.

2. **Grammar fix — "it's" → "its":**
```diff
- * 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.
```
Correct — "its" (possessive) is right here, not "it's" (contraction of "it is").

**Observations:**
- The `Fixes:` tag references `3e5067931b5d ("dma-buf: abstract fence locking v2")` which is the commit that introduced the doc comment with the typos. Appropriate.
- The patch is against `linux-next-20260406` (visible from the `---`/`+++` paths). The drm-next tree already contains both fixes at lines 411 and 413, so this patch has already been merged or an equivalent fix was applied independently.
- The diff context, line numbers, and surrounding code all check out.
- Appropriate Cc list (Christian König as dma-buf/dma-fence maintainer, Sumit Semwal, linux-media).

**Verdict:** The patch is correct in both substance and form, but is a no-op against current drm-next since the fix is already present. If reviewing against the original base where the typos still exist, this is a clean **Reviewed-by**-worthy patch.

---
Generated by Claude Code Patch Reviewer

Claude review: dma-fence: correct kernel-doc function parameter @flags

[Claude Code Review Bot]

Overall Series Review

Subject: dma-fence: correct kernel-doc function parameter @flags
Author: Randy Dunlap <rdunlap@infradead.org>
Patches: 2
Reviewed: 2026-04-12T14:05:33.306870

---

This is a single-patch series from Randy Dunlap fixing a kernel-doc warning and a minor grammar issue in the `dma_fence_unlock_irqrestore` documentation comment in `include/linux/dma-fence.h`. The patch is trivially correct and addresses a real `make htmldocs` warning.

Notably, this fix has **already been applied** in the drm-next tree — the current source at line 411 already reads `@flags:` (with colon) and line 413 already reads `its` (without the errant apostrophe). This means the patch (or an equivalent fix) was already merged via commit 3e5067931b5d's fixup or a similar submission.

---
Generated by Claude Code Patch Reviewer