public inbox for drm-ai-reviews@public-inbox.freedesktop.org
 help / color / mirror / Atom feed
From: Claude Code Review Bot <claude-review@example.com>
To: dri-devel-reviews@example.com
Subject: Claude review: nouveau/gsp/rpc: Document RPC function return value contracts
Date: Thu, 04 Jun 2026 14:22:54 +1000	[thread overview]
Message-ID: <review-patch1-20260601095403.228220-2-zenghongling@kylinos.cn> (raw)
In-Reply-To: <20260601095403.228220-2-zenghongling@kylinos.cn>

Patch Review

This patch adds kernel-doc comments documenting return value semantics. The analysis is mostly correct, but there is a **major placement bug**:

The doc comment for `r535_gsp_rpc_get` is placed before `r535_gsp_rpc_done()`, not before `r535_gsp_rpc_get()`:

```c
+/**
+ * r535_gsp_rpc_get - Allocate and initialize an RPC message
+ * @gsp: GSP device
+ * @fn: RPC function number
+ * @payload_size: Size of the payload
+ *
+ * Return: Pointer to RPC payload data on success, or ERR_PTR() on error.
+ *         Never returns NULL.
+ */
 static void
 r535_gsp_rpc_done(struct nvkm_gsp *gsp, void *repv)
```

In the source, `r535_gsp_rpc_done()` (line 604) comes before `r535_gsp_rpc_get()` (line 612). The doc comment is attached to the wrong function. The kernel-doc tooling would associate this `@gsp`, `@fn`, `@payload_size` documentation with `r535_gsp_rpc_done`, which only takes `(gsp, repv)` — a parameter mismatch that would produce kernel-doc warnings.

Minor: these are all `static` functions, so kernel-doc comments are somewhat unconventional here — inline `/* */` comments noting the return contract would suffice and be less maintenance burden.

---
Generated by Claude Code Patch Reviewer

  reply	other threads:[~2026-06-04  4:22 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-06-01  9:53 [PATCH v2 0/5] nouveau/gsp: Clean up IS_ERR vs IS_ERR_OR_NULL usage Hongling Zeng
2026-06-01  9:53 ` [PATCH v2 1/5] nouveau/gsp/rpc: Document RPC function return value contracts Hongling Zeng
2026-06-04  4:22   ` Claude Code Review Bot [this message]
2026-06-01  9:54 ` [PATCH v2 2/5] nouveau/gsp/rpc: Cleanup incorrect IS_ERR_OR_NULL in rpc.c Hongling Zeng
2026-06-04  4:22   ` Claude review: " Claude Code Review Bot
2026-06-01  9:54 ` [PATCH v2 3/5] nouveau/gsp/rm/alloc: Cleanup IS_ERR_OR_NULL usage Hongling Zeng
2026-06-04  4:22   ` Claude review: " Claude Code Review Bot
2026-06-01  9:54 ` [PATCH v2 4/5] nouveau/gsp/rm/bar: " Hongling Zeng
2026-06-04  4:22   ` Claude review: " Claude Code Review Bot
2026-06-01  9:54 ` [PATCH v2 5/5] nouveau/gsp: Cleanup IS_ERR_OR_NULL in nvkm_gsp_rpc_rd() Hongling Zeng
2026-06-04  4:22   ` Claude review: " Claude Code Review Bot
2026-06-04  4:22 ` Claude review: nouveau/gsp: Clean up IS_ERR vs IS_ERR_OR_NULL usage Claude Code Review Bot

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=review-patch1-20260601095403.228220-2-zenghongling@kylinos.cn \
    --to=claude-review@example.com \
    --cc=dri-devel-reviews@example.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox