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: drm/tegra: tegra_drm.h: fix all uapi kernel-doc warnings
Date: Thu, 05 Mar 2026 13:56:55 +1000	[thread overview]
Message-ID: <review-patch1-20260304014152.482104-1-rdunlap@infradead.org> (raw)
In-Reply-To: <20260304014152.482104-1-rdunlap@infradead.org>

Patch Review

**Struct member fixes (correct):**

The additions at lines 108 and 116 of the patch are appropriate:

```c
+	/** @cmdbuf: cmd information */
	struct {
```

```c
+	/** @target: relocate target information */
	struct {
```

These correctly add the missing top-level member descriptions for the anonymous struct members `cmdbuf` and `target` within `struct drm_tegra_reloc`, resolving the first two warnings.

**#define macro doc-comments (incorrect syntax):**

The kernel-doc comments added for the `#define` constants use incorrect syntax. For example:

```c
/**
+ * define DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT - \
+ *    Select sector layout swizzling for in-memory buffers.
+ *
  * Specify that bit 39 of the patched-in address should be set to switch
```

The correct kernel-doc syntax for a `#define` requires a leading `DOC:` tag or more typically for constants, simply converting `/**` to `/*` to suppress the warning. If the intent is to make these proper kernel-doc comments, the syntax should be:

```c
/**
 * DOC: DRM_TEGRA_SUBMIT_RELOC_SECTOR_LAYOUT
 *
 * Select sector layout swizzling ...
```

The `define MACRO_NAME - description` format used in this patch is not valid kernel-doc syntax. The kernel-doc script recognizes `@define` for macro-like entities but the format here (`define NAME - \`) doesn't match any recognized kernel-doc pattern. This will likely either still produce warnings or produce malformed documentation output.

The same issue applies to all three `DRM_TEGRA_SUBMIT_CMD_*` defines.

**Alternative fix:** If the goal is simply to silence the warnings (since these are simple constants, not function-like macros), the simplest approach is to change `/**` to `/*`, which avoids triggering the kernel-doc parser entirely while preserving the descriptive comments. This was effectively what v1 of Mikko's feedback was about — but if proper kernel-doc is desired, the `DOC:` form or the correct macro documentation syntax should be used.

**Minor nit:** The member description `cmd information` for `@cmdbuf` is quite vague. Something like `command buffer relocation info` would be more descriptive, though this is stylistic.

---
Generated by Claude Code Patch Reviewer

  parent reply	other threads:[~2026-03-05  3:56 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-03-04  1:41 [PATCH v2] drm/tegra: tegra_drm.h: fix all uapi kernel-doc warnings Randy Dunlap
2026-03-04  2:59 ` Mikko Perttunen
2026-03-05  3:56 ` Claude review: " Claude Code Review Bot
2026-03-05  3:56 ` Claude Code Review Bot [this message]
  -- strict thread matches above, loose matches on Subject: below --
2026-02-26 21:58 [PATCH] " Randy Dunlap
2026-02-27  1:38 ` Claude review: " Claude Code Review Bot
2026-02-27  1:38 ` 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-20260304014152.482104-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