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: gpu: ipu-v3: clean up kernel-doc warnings
Date: Mon, 23 Feb 2026 06:22:16 +1000	[thread overview]
Message-ID: <review-patch1-20260219215211.459108-1-rdunlap@infradead.org> (raw)
In-Reply-To: <20260219215211.459108-1-rdunlap@infradead.org>

Patch Review

No functional issues. All changes are kernel-doc comment fixes that address the specific warnings listed in the commit message.

> +	/* private: */
>  	/* internal to image converter, callers don't touch */
>  	struct list_head list;

Correct use of the `/* private: */` kernel-doc annotation to suppress the warning about undocumented `list` member.

> - * ipu_image_convert_cb_t - conversion callback function prototype
> + * typedef ipu_image_convert_cb_t - conversion callback function prototype

Correct fix. Kernel-doc requires `typedef` for typedef documentation.

> - * Returns 0 if the formats and rotation mode meet IPU restrictions,
> + * Returns: 0 if the formats and rotation mode meet IPU restrictions,

Correct. Kernel-doc expects `Returns:` with a colon.

> - * Returns an opaque conversion context pointer on success, error pointer
> + * In V4L2, drivers should call ipu_image_convert_prepare() at streamon.
> + *
> + * Returns: an opaque conversion context pointer on success, error pointer
>   * on failure. The input/output formats and rotation mode must already meet
>   * IPU retrictions.
> - *
> - * In V4L2, drivers should call ipu_image_convert_prepare() at streamon.

This moves the `In V4L2` note before `Returns:` so the return value documentation appears last. This is the correct kernel-doc convention -- `Returns:` should be the final section. One minor note: the pre-existing typo "retrictions" (should be "restrictions") survives this patch, but fixing it is outside the scope of a doc-format cleanup.

> + * Returns: 0 on success or -errno on error.

> + * Returns: pointer to the created &struct ipu_image_convert_run that has
> + * been queued on success; an ERR_PTR(errno) on error.

Both additions are accurate descriptions matching the function signatures and existing documentation prose.

No issues found. The patch is a clean documentation fix that addresses all seven kernel-doc warnings listed in the commit message.

---
Generated by Claude Code Patch Reviewer

  reply	other threads:[~2026-02-22 20:22 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-02-19 21:52 [PATCH v2] gpu: ipu-v3: clean up kernel-doc warnings Randy Dunlap
2026-02-22 20:22 ` Claude Code Review Bot [this message]
2026-02-22 20:22 ` Claude review: " 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-20260219215211.459108-1-rdunlap@infradead.org \
    --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