[PATCH v2] drm/gpusvm: Drop redundant @flags.* kernel-doc on struct drm_gpusvm_pages

[PATCH v2] drm/gpusvm: Drop redundant @flags.* kernel-doc on struct drm_gpusvm_pages

[Shuicheng Lin]

The kernel-doc block above struct drm_gpusvm_pages duplicates the
descriptions of the bit-flags that live in struct drm_gpusvm_pages_flags
using dotted notation (@flags.migrate_devmem, @flags.unmapped, ...).
That dotted notation is intended for nested anonymous structs/unions that
the parser flattens into the parent's parameter list.  Here, however,
flags is of a named external type, so the parser does not flatten its
members and the dotted entries do not match any member of
drm_gpusvm_pages.  They also duplicate the canonical descriptions already
present in the kernel-doc of struct drm_gpusvm_pages_flags itself.

Drop the five @flags.* lines and replace them with a single @flags entry
that cross-references the type via kernel-doc's "&struct ..." syntax.
This eliminates the redundancy and removes warnings emitted by the new
parameterdescs check in scripts/kernel-doc:

  Excess struct member 'flags.migrate_devmem' description in
   'drm_gpusvm_pages'
  Excess struct member 'flags.unmapped' description in 'drm_gpusvm_pages'
  Excess struct member 'flags.partial_unmap' description in
   'drm_gpusvm_pages'
  Excess struct member 'flags.has_devmem_pages' description in
   'drm_gpusvm_pages'
  Excess struct member 'flags.has_dma_mapping' description in
   'drm_gpusvm_pages'

No functional change.

v2: change base to drm-misc.

Assisted-by: GitHub Copilot <copilot@github.com>
Cc: Matthew Auld <matthew.auld@intel.com>
Signed-off-by: Shuicheng Lin <shuicheng.lin@intel.com>
---                                                                             
The failure is reported by the new kernel-doc check in: https://patchwork.freedesktop.org/series/164948/
---
 include/drm/drm_gpusvm.h | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/include/drm/drm_gpusvm.h b/include/drm/drm_gpusvm.h
index cd94bb2ee6ee..8a4d7134a9a7 100644
--- a/include/drm/drm_gpusvm.h
+++ b/include/drm/drm_gpusvm.h
@@ -140,12 +140,7 @@ struct drm_gpusvm_pages_flags {
  * @state: DMA IOVA state for mapping.
  * @state_offset: DMA IOVA offset for mapping.
  * @notifier_seq: Notifier sequence number of the range's pages
- * @flags: Flags for range
- * @flags.migrate_devmem: Flag indicating whether the range can be migrated to device memory
- * @flags.unmapped: Flag indicating if the range has been unmapped
- * @flags.partial_unmap: Flag indicating if the range has been partially unmapped
- * @flags.has_devmem_pages: Flag indicating if the range has devmem pages
- * @flags.has_dma_mapping: Flag indicating if the range has a DMA mapping
+ * @flags: Flags for the range; see &struct drm_gpusvm_pages_flags
  */
 struct drm_gpusvm_pages {
 	struct drm_pagemap_addr *dma_addr;
-- 
2.43.0

Claude review: drm/gpusvm: Drop redundant @flags.* kernel-doc on struct drm_gpusvm_pages

[Claude Code Review Bot]

Overall Series Review

Subject: drm/gpusvm: Drop redundant @flags.* kernel-doc on struct drm_gpusvm_pages
Author: Shuicheng Lin <shuicheng.lin@intel.com>
Patches: 1
Reviewed: 2026-05-05T09:12:49.244063

---

This is a single trivial kernel-doc fix for `struct drm_gpusvm_pages` in `include/drm/drm_gpusvm.h`. The change is correct and well-motivated. The existing kernel-doc uses `@flags.*` dotted notation (e.g., `@flags.migrate_devmem`) to document sub-fields of the `flags` member, but that notation only works for **anonymous** embedded structs that kernel-doc flattens into the parent. Here, `flags` is of the named type `struct drm_gpusvm_pages_flags`, which already has its own kernel-doc block — so the dotted entries are redundant, don't match any flattened member, and generate "Excess struct member" warnings from `scripts/kernel-doc`.

The fix correctly drops the five `@flags.*` lines and replaces them with a single `@flags` entry using the `&struct drm_gpusvm_pages_flags` cross-reference. No functional change.

The commit message is clear and thorough, including the exact warnings being fixed and a link to the failing CI series. No concerns with the patch itself.

**Minor process note:** The patch lists `Assisted-by: GitHub Copilot` and Cc's `copilot@github.com`. While this is a trivial doc change, some subsystem maintainers have policies about AI-attribution tags — worth checking if drm-misc has any stance on this. The `Assisted-by:` tag is not an officially recognized kernel tag (unlike `Co-developed-by:` or `Suggested-by:`).

**Verdict:** Looks good. Trivial and correct fix.

---

---
Generated by Claude Code Patch Reviewer

Claude review: drm/gpusvm: Drop redundant @flags.* kernel-doc on struct drm_gpusvm_pages

[Claude Code Review Bot]

Patch Review

**Correctness: Good.** The distinction between anonymous structs (where dotted notation is valid) and named struct types (where it isn't) is correctly identified. Compare with `struct drm_gpusvm_notifier` in the same file (line ~96 in the current tree), which uses `@flags.removed` — and that one is correct because `flags` there is an anonymous `struct { u32 removed : 1; }`, not a named type.

**The replacement line is well-formed:**
```
- * @flags: Flags for range
- * @flags.migrate_devmem: Flag indicating whether the range can be migrated to device memory
- * @flags.unmapped: Flag indicating if the range has been unmapped
- * @flags.partial_unmap: Flag indicating if the range has been partially unmapped
- * @flags.has_devmem_pages: Flag indicating if the range has devmem pages
- * @flags.has_dma_mapping: Flag indicating if the range has a DMA mapping
+ * @flags: Flags for the range; see &struct drm_gpusvm_pages_flags
```

The `&struct drm_gpusvm_pages_flags` syntax is standard kernel-doc cross-referencing and will produce a hyperlink in the generated documentation.

**One very minor nit:** The wording changed from "Flags for range" to "Flags for the range" (added "the"). Fine, slightly better English.

**No issues found.** 

Reviewed-by worthy.

---
Generated by Claude Code Patch Reviewer