public inbox for drm-ai-reviews@public-inbox.freedesktop.org
 help / color / mirror / Atom feed
* [PATCH] backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data
@ 2026-03-12 21:42 John S
  2026-03-13 21:32 ` Claude review: " Claude Code Review Bot
  2026-03-13 21:32 ` Claude Code Review Bot
  0 siblings, 2 replies; 3+ messages in thread
From: John S @ 2026-03-12 21:42 UTC (permalink / raw)
  To: lee, danielt, jingoohan1; +Cc: deller, dri-devel, linux-fbdev, linux-kernel

Add the required 'struct cgbc_bl_data -' prefix to the kernel-doc
comment so it is properly recognized as struct documentation.

This fixes the following warning:

  drivers/video/backlight/cgbc_bl.c:29: This comment starts with
'/**', but isn't a kernel-doc comment

Signed-off-by: Kit Dallege <xaum.io@gmail.com>
---
 drivers/video/backlight/cgbc_bl.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/drivers/video/backlight/cgbc_bl.c
b/drivers/video/backlight/cgbc_bl.c
index 9212c498e6e3..0964205ef1ab 100644
--- a/drivers/video/backlight/cgbc_bl.c
+++ b/drivers/video/backlight/cgbc_bl.c
@@ -26,7 +26,7 @@
 #define CGBC_BL_MAX_BRIGHTNESS     100

 /**
- * CGBC backlight driver data
+ * struct cgbc_bl_data - CGBC backlight driver data
  * @dev: Pointer to the platform device
  * @cgbc: Pointer to the parent CGBC device data
  * @current_brightness: Current brightness level (0-100)
--
2.53.0

^ permalink raw reply related	[flat|nested] 3+ messages in thread

* Claude review: backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data
  2026-03-12 21:42 [PATCH] backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data John S
@ 2026-03-13 21:32 ` Claude Code Review Bot
  2026-03-13 21:32 ` Claude Code Review Bot
  1 sibling, 0 replies; 3+ messages in thread
From: Claude Code Review Bot @ 2026-03-13 21:32 UTC (permalink / raw)
  To: dri-devel-reviews

Overall Series Review

Subject: backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data
Author: John S <xaum.io@gmail.com>
Patches: 1
Reviewed: 2026-03-14T07:32:08.789982

---

This is a single, straightforward kernel-doc fix patch. The change is correct and addresses a legitimate `kernel-doc` warning. The existing comment at line 30 uses the `/**` kernel-doc marker but lacks the required `struct <name> -` prefix, so the documentation tooling cannot associate it with `struct cgbc_bl_data`. The fix is minimal and appropriate.

**Verdict: Looks good.**

---
Generated by Claude Code Patch Reviewer

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Claude review: backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data
  2026-03-12 21:42 [PATCH] backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data John S
  2026-03-13 21:32 ` Claude review: " Claude Code Review Bot
@ 2026-03-13 21:32 ` Claude Code Review Bot
  1 sibling, 0 replies; 3+ messages in thread
From: Claude Code Review Bot @ 2026-03-13 21:32 UTC (permalink / raw)
  To: dri-devel-reviews

Patch Review

**Status: Correct**

The patch changes:
```
- * CGBC backlight driver data
+ * struct cgbc_bl_data - CGBC backlight driver data
```

This is the correct kernel-doc format for documenting a struct. The `/**` marker at line 29 of `cgbc_bl.c` signals a kernel-doc comment, but without the `struct cgbc_bl_data -` prefix, `scripts/kernel-doc` cannot parse it and emits the warning quoted in the commit message.

I confirmed against the kernel tree that line 30 currently reads `* CGBC backlight driver data` and is immediately followed by `@dev`, `@cgbc`, and `@current_brightness` field descriptions (lines 31-33), with `struct cgbc_bl_data` declared at line 35. The fix correctly names the struct and retains the existing description text after the `-` separator.

**Minor nit (non-blocking):** The `From:` header shows `John S <xaum.io@gmail.com>` while the `Signed-off-by` uses `Kit Dallege <xaum.io@gmail.com>`. The email address matches, but the name mismatch between the author and signoff may raise questions from maintainers. The author should ensure consistency (typically a maintainer would ask which name to use).

Otherwise, no issues. The patch is trivially correct.

---
Generated by Claude Code Patch Reviewer

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2026-03-13 21:32 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2026-03-12 21:42 [PATCH] backlight: cgbc_bl: fix kernel-doc comment for struct cgbc_bl_data John S
2026-03-13 21:32 ` Claude review: " Claude Code Review Bot
2026-03-13 21:32 ` Claude Code Review Bot

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox