[PATCH] drm/i915: fix outdated i915_vma_get_fence() references in kdoc

[PATCH] drm/i915: fix outdated i915_vma_get_fence() references in kdoc

[Kexin Sun]

The function i915_vma_get_fence() was merged into
i915_vma_pin_fence() by commit 3bd4073524fa ("drm/i915:
Consolidate get_fence with pin_fence").

Remove the stale sentence that tells callers to synchronize
fencing state by calling i915_vma_get_fence() first, and fix
the Returns description: i915_vma_pin_fence() returns int
(0 on success, negative error code on failure), not bool as
the old i915_vma_get_fence() did.

Assisted-by: unnamed:deepseek-v3.2 coccinelle
Signed-off-by: Kexin Sun <kexinsun@smail.nju.edu.cn>
---
 drivers/gpu/drm/i915/i915_vma.h | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/drivers/gpu/drm/i915/i915_vma.h b/drivers/gpu/drm/i915/i915_vma.h
index 8054047840aa..14ad66f8b398 100644
--- a/drivers/gpu/drm/i915/i915_vma.h
+++ b/drivers/gpu/drm/i915/i915_vma.h
@@ -369,14 +369,13 @@ void i915_vma_unpin_iomap(struct i915_vma *vma);
  * @vma: vma to pin fencing for
  *
  * This pins the fencing state (whether tiled or untiled) to make sure the
- * vma (and its object) is ready to be used as a scanout target. Fencing
- * status must be synchronize first by calling i915_vma_get_fence():
+ * vma (and its object) is ready to be used as a scanout target.
  *
  * The resulting fence pin reference must be released again with
  * i915_vma_unpin_fence().
  *
  * Returns:
- * True if the vma has a fence, false otherwise.
+ * 0 on success, negative error code on failure.
  */
 int __must_check i915_vma_pin_fence(struct i915_vma *vma);
 void i915_vma_revoke_fence(struct i915_vma *vma);
-- 
2.25.1

Claude review: drm/i915: fix outdated i915_vma_get_fence() references in kdoc

[Claude Code Review Bot]

Overall Series Review

Subject: drm/i915: fix outdated i915_vma_get_fence() references in kdoc
Author: Kexin Sun <kexinsun@smail.nju.edu.cn>
Patches: 1
Reviewed: 2026-03-22T03:01:55.569086

---

This is a single-patch series that fixes stale kernel-doc comments for `i915_vma_pin_fence()`. The patch is correct, well-scoped, and the commit message clearly explains the history (commit `3bd4073524fa` consolidated `i915_vma_get_fence()` into `i915_vma_pin_fence()`). The changes are documentation-only and pose zero risk.

---
Generated by Claude Code Patch Reviewer

Claude review: drm/i915: fix outdated i915_vma_get_fence() references in kdoc

[Claude Code Review Bot]

Patch Review

**Correctness: Good.** Both changes are accurate:

1. Removing the stale sentence referencing `i915_vma_get_fence()` is correct — that function no longer exists.
2. Fixing the `Returns:` from "True if the vma has a fence, false otherwise" to "0 on success, negative error code on failure" is correct — the function signature is `int __must_check i915_vma_pin_fence(struct i915_vma *vma)` at line 380, confirming it returns `int`, not `bool`.

**Minor nit on the commit metadata:**

The tag `Assisted-by: unnamed:deepseek-v3.2 coccinelle` is non-standard. The kernel community doesn't have a recognized `Assisted-by:` trailer. If an AI tool was used, some maintainers may want this noted differently, or it may raise questions during review. The maintainer will likely ask about this.

**Verdict:** The patch itself is correct and should be safe to apply. No functional code changes, only kdoc fixes.

---
Generated by Claude Code Patch Reviewer