[PATCH] Fix kernel-doc for amdgpu_display_manager

[PATCH] Fix kernel-doc for amdgpu_display_manager

[Kenner de Azevedo dos Santos Miranda]

The struct boot_time_crc_info is not described in amdgpu_display_manager.

Running the `make htmldocs` is showing the following warning :

WARNING: ./drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h:715 struct member 'boot_time_crc_info' not described in 'amdgpu_display_manager'

i added the description that fix the warning and describe the struct.

The warning is not showing anymore in make htmldocs after change.

Signed-off-by: Kenner de Azevedo dos Santos Miranda <kenner.linuxdev@gmail.com>
---
 drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h | 1 +
 1 file changed, 1 insertion(+)

diff --git a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
index 74a8fe1a1999..201b4796b591 100644
--- a/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
+++ b/drivers/gpu/drm/amd/display/amdgpu_dm/amdgpu_dm.h
@@ -347,6 +347,7 @@ struct hpd_rx_irq_offload_work {
  * @dmub_aux_transfer_done: struct completion used to indicate when DMUB
  * 			    transfers are done
  * @delayed_hpd_wq: work queue used to delay DMUB HPD work
+ * @boot_time_crc_info: Stores CRC information collected during boot
  */
 struct amdgpu_display_manager {
 
-- 
2.43.0

Claude review: Fix kernel-doc for amdgpu_display_manager

[Claude Code Review Bot]

Overall Series Review

Subject: Fix kernel-doc for amdgpu_display_manager
Author: Kenner de Azevedo dos Santos Miranda <kenner.linuxdev@gmail.com>
Patches: 1
Reviewed: 2026-05-05T10:56:41.433830

---

This is a single-patch series that adds a missing kernel-doc `@member` description for `boot_time_crc_info` in the top-level struct-level documentation block for `struct amdgpu_display_manager`. The fix is correct and addresses a real `make htmldocs` warning. It's a trivially safe documentation-only change.

**Verdict: Acceptable.** Minor nit on commit message style (see below), but the patch itself is correct.

---
Generated by Claude Code Patch Reviewer

Claude review: Fix kernel-doc for amdgpu_display_manager

[Claude Code Review Bot]

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