[PATCH] drm/exec: drm_exec.h: eliminate kernel-doc warnings

[PATCH] drm/exec: drm_exec.h: eliminate kernel-doc warnings

[Randy Dunlap]

Repair kernel-doc comments to avoid kernel-doc warnings:

Warning: include/drm/drm_exec.h:146 No description found for return value of 'drm_exec_is_contended'
WARNING: include/drm/drm_exec.h:157 function parameter '_exec' not described in 'drm_exec_retry'
WARNING: include/drm/drm_exec.h:157 Excess function parameter 'exec' description in 'drm_exec_retry'

Fixes: bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec retry pointer")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: David Airlie <airlied@gmail.com>
Cc: Simona Vetter <simona@ffwll.ch>
Cc: Thomas Hellström <thomas.hellstrom@linux.intel.com>
Cc: Maarten Lankhorst <maarten.lankhorst@linux.intel.com>
Cc: Maxime Ripard <mripard@kernel.org>
Cc: Thomas Zimmermann <tzimmermann@suse.de>
---
 include/drm/drm_exec.h |    4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

--- linux-next-20260527.orig/include/drm/drm_exec.h
+++ linux-next-20260527/include/drm/drm_exec.h
@@ -140,7 +140,7 @@ _label:									 \
  * drm_exec_is_contended - check for contention
  * @exec: drm_exec object
  *
- * Returns true if the drm_exec object has run into some contention while
+ * Returns: true if the drm_exec object has run into some contention while
  * locking a GEM object and needs to clean up.
  */
 static inline bool drm_exec_is_contended(struct drm_exec *exec)
@@ -150,7 +150,7 @@ static inline bool drm_exec_is_contended
 
 /**
  * drm_exec_retry() - Unconditionally restart the loop to grab all locks.
- * @exec: drm_exec object
+ * @_exec: drm_exec object
  *
  * Unconditionally retry the loop to lock all objects. For consistency,
  * the exec object needs to be newly initialized.

Claude review: drm/exec: drm_exec.h: eliminate kernel-doc warnings

[Claude Code Review Bot]

Overall Series Review

Subject: drm/exec: drm_exec.h: eliminate kernel-doc warnings
Author: Randy Dunlap <rdunlap@infradead.org>
Patches: 1
Reviewed: 2026-05-28T12:04:23.470549

---

This is a single-patch series from Randy Dunlap fixing kernel-doc warnings in `include/drm/drm_exec.h`. The patch is trivial and correct — it addresses two distinct kernel-doc issues:

1. **Missing `Returns:` tag** — kernel-doc requires `Returns:` (with colon) rather than just `Returns` for return value documentation.
2. **Parameter name mismatch** — the `drm_exec_retry()` macro uses `_exec` as its parameter name but the kernel-doc documented it as `@exec`.

Both fixes are mechanical and match the actual code. The Fixes tag references `bba175a2d4be ("drm/exec, drm/xe: Avoid abusing the drm_exec retry pointer")` which introduced `drm_exec_retry()` with the underscore-prefixed parameter and the `drm_exec_is_contended()` return value issue. Note: The patches did not apply to the drm-next tree because the referenced commit (which adds `drm_exec_retry()`) has not yet landed on drm-next — the tree only has `drm_exec_retry_on_contention`, not `drm_exec_retry`.

**Verdict: Patch looks good.** No functional concerns.

---
Generated by Claude Code Patch Reviewer

Claude review: drm/exec: drm_exec.h: eliminate kernel-doc warnings

[Claude Code Review Bot]

Patch Review

**Change 1 — `Returns` → `Returns:`** (line 88 of the mbox)

```diff
- * Returns true if the drm_exec object has run into some contention while
+ * Returns: true if the drm_exec object has run into some contention while
```

Correct. The kernel-doc parser requires the `Returns:` keyword (with colon) to properly recognize and format return value descriptions. Without the colon, kernel-doc emits:
```
Warning: include/drm/drm_exec.h:146 No description found for return value of 'drm_exec_is_contended'
```

**Change 2 — `@exec` → `@_exec`** (line 97 of the mbox)

```diff
- * @exec: drm_exec object
+ * @_exec: drm_exec object
```

Correct. The `drm_exec_retry()` macro uses `_exec` as its parameter name (with leading underscore, a common pattern for macro arguments to avoid shadowing), but the kernel-doc comment documented it as `@exec`. This mismatch produces two warnings — the actual parameter `_exec` is undescribed and `exec` is flagged as excess. The fix aligns the documentation with the actual parameter name.

**No issues found.** Both changes are straightforward kernel-doc documentation fixes with no functional impact.

---
Generated by Claude Code Patch Reviewer