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: Fix kernel-doc for amdgpu_display_manager
Date: Tue, 05 May 2026 10:56:41 +1000	[thread overview]
Message-ID: <review-patch1-20260430010405.52591-1-kenner.linuxdev@gmail.com> (raw)
In-Reply-To: <20260430010405.52591-1-kenner.linuxdev@gmail.com>

Patch Review

**Change:** Adds one line to the struct-level kernel-doc comment block (lines 321-351 of `amdgpu_dm.h`) for the `@boot_time_crc_info` member:

```
+ * @boot_time_crc_info: Stores CRC information collected during boot
```

**Assessment: Correct.**

The `boot_time_crc_info` member (line 708, `struct dm_boot_time_crc_info boot_time_crc_info`) already has an inline per-member kernel-doc comment at lines 703-707, but the top-level struct documentation comment was missing the corresponding `@boot_time_crc_info` entry — which is what triggers the `make htmldocs` warning. The added description is consistent with the inline comment ("Buffer info for the boot time crc") and the struct definition (`struct dm_boot_time_crc_info` at lines 112-124, which holds a CPU address, BO pointer, GPU address, and size for a boot-time CRC buffer).

**Nits (minor, not blocking):**

1. **Commit subject line** — The subject `Fix kernel-doc for amdgpu_display_manager` lacks the conventional subsystem prefix. Typical AMDGPU display patches use `drm/amd/display:` as a prefix, e.g.:
   ```
   drm/amd/display: Fix kernel-doc warning for amdgpu_display_manager
   ```

2. **Commit message style** — The body uses first person ("i added the description") which is unusual for kernel commit messages; the conventional kernel style uses imperative mood ("Add the missing description..."). The lowercase "i" should also be capitalized.

3. **Completeness** — The top-level struct doc comment is missing descriptions for many other members beyond `boot_time_crc_info` (the struct has ~50+ members but the top comment only documents ~18). This patch only silences *one* warning, but that's fine — fixing all missing descriptions is out of scope for this patch.

**No functional concerns** — this is a documentation-only change with zero runtime impact.

---
Generated by Claude Code Patch Reviewer

  reply	other threads:[~2026-05-05  0:56 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-30  1:04 [PATCH] Fix kernel-doc for amdgpu_display_manager Kenner de Azevedo dos Santos Miranda
2026-05-05  0:56 ` Claude Code Review Bot [this message]
2026-05-05  0:56 ` 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-20260430010405.52591-1-kenner.linuxdev@gmail.com \
    --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