public inbox for linux-next@vger.kernel.org 
 help / color / mirror / Atom feed
* [PATCH] media: uapi: c3-isp: Fix documentation warning
@ 2025-11-27  8:43 Jacopo Mondi
  0 siblings, 0 replies; only message in thread
From: Jacopo Mondi @ 2025-11-27  8:43 UTC (permalink / raw)
  To: Mauro Carvalho Chehab, Hans Verkuil, Stephen Rothwell
  Cc: Jacopo Mondi, Linux Kernel Mailing List, Linux Next Mailing List,
	stable

Building htmldocs generates a warning:

WARNING: include/uapi/linux/media/amlogic/c3-isp-config.h:199
error: Cannot parse struct or union!

Which correctly highlights that the c3_isp_params_block_header symbol
is wrongly documented as a struct while it's a plain #define instead.

Fix this by removing the 'struct' identifier from the documentation of
the c3_isp_params_block_header symbol.

Reported-by: Stephen Rothwell <sfr@canb•auug.org.au>
Fixes: 45662082855c ("media: uapi: Convert Amlogic C3 to V4L2 extensible params")
Cc: stable@vger•kernel.org
Signed-off-by: Jacopo Mondi <jacopo.mondi@ideasonboard•com>
---
Stephen reported this error on linux-next. Please collect this patch for v6.19.

I'm not sure this qualifies for stable, as it will ideally land in the same
release as the patch that introduces the warning. If that's not the case, please
strip:

Fixes: 45662082855c ("media: uapi: Convert Amlogic C3 to V4L2 extensible params")
Cc: stable@vger•kernel.org

from the commit message when applying, thanks!

---
 include/uapi/linux/media/amlogic/c3-isp-config.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/uapi/linux/media/amlogic/c3-isp-config.h b/include/uapi/linux/media/amlogic/c3-isp-config.h
index 0a3c1cc55ccb..92db5dcdda18 100644
--- a/include/uapi/linux/media/amlogic/c3-isp-config.h
+++ b/include/uapi/linux/media/amlogic/c3-isp-config.h
@@ -186,7 +186,7 @@ enum c3_isp_params_block_type {
 #define C3_ISP_PARAMS_BLOCK_FL_ENABLE	V4L2_ISP_PARAMS_FL_BLOCK_ENABLE

 /**
- * struct c3_isp_params_block_header - C3 ISP parameter block header
+ * c3_isp_params_block_header - C3 ISP parameter block header
  *
  * This structure represents the common part of all the ISP configuration
  * blocks and is identical to :c:type:`v4l2_isp_params_block_header`.
--
2.51.1


^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2025-11-27  8:44 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2025-11-27  8:43 [PATCH] media: uapi: c3-isp: Fix documentation warning Jacopo Mondi

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