[PATCH 1/3] media: uapi: c3-isp: Fix documentation warning

Ricardo Ribalda posted 3 patches 2 weeks, 2 days ago
There is a newer version of this series
[PATCH 1/3] media: uapi: c3-isp: Fix documentation warning
Posted by Ricardo Ribalda 2 weeks, 2 days ago
From: Jacopo Mondi <jacopo.mondi@ideasonboard.com>

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.

[ribalda: Add Closes:]

Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/all/20251127131425.4b5b6644@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>
Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
---
 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 0a3c1cc55ccbbad12f18037d65f32ec9ca1a4ec0..92db5dcdda181cb31665e230cc56b443fa37a0be 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.52.0.158.g65b55ccf14-goog
Re: [PATCH 1/3] media: uapi: c3-isp: Fix documentation warning
Posted by Mauro Carvalho Chehab 2 weeks, 2 days ago
Em Wed, 03 Dec 2025 08:55:34 +0000
Ricardo Ribalda <ribalda@chromium.org> escreveu:

> From: Jacopo Mondi <jacopo.mondi@ideasonboard.com>
> 
> 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.
> 
> [ribalda: Add Closes:]
> 
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/all/20251127131425.4b5b6644@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>
> Signed-off-by: Ricardo Ribalda <ribalda@chromium.org>
> ---
>  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 0a3c1cc55ccbbad12f18037d65f32ec9ca1a4ec0..92db5dcdda181cb31665e230cc56b443fa37a0be 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`.
> 

Just merged this one at media-committers next. 

My plan is to send later during the merge window, after the first
PR I sent upstream gets merged.

Regards,
Mauro