[PATCH] doc: ipu3: Fix UAPI header doc warnings

[PATCH] doc: ipu3: Fix UAPI header doc warnings

[Kohshi Yamaguchi]

The ipu3_uapi_acc_param struct in the IPU3 UAPI header mentioned
reserved1 and reserved2 fields, which are absent in the actual
structure definition. This mismatch led to Sphinx build warnings
due to inconsistencies between the documentation and the code.

This patch removes these non-existent reserved field references
from the documentation, resolving the Sphinx build warnings and
ensuring the UAPI header is accurately documented.

Signed-off-by: Kohshi Yamaguchi <kohshi54.yam@gmail.com>
---
 drivers/staging/media/ipu3/include/uapi/intel-ipu3.h | 2 --
 1 file changed, 2 deletions(-)

diff --git a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
index caa358e0bae4..926fcf84e33c 100644
--- a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
+++ b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
@@ -2485,11 +2485,9 @@ struct ipu3_uapi_anr_config {
  *		&ipu3_uapi_yuvp1_y_ee_nr_config
  * @yds:	y down scaler config. See &ipu3_uapi_yuvp1_yds_config
  * @chnr:	chroma noise reduction config. See &ipu3_uapi_yuvp1_chnr_config
- * @reserved1: reserved
  * @yds2:	y channel down scaler config. See &ipu3_uapi_yuvp1_yds_config
  * @tcc:	total color correction config as defined in struct
  *		&ipu3_uapi_yuvp2_tcc_static_config
- * @reserved2: reserved
  * @anr:	advanced noise reduction config.See &ipu3_uapi_anr_config
  * @awb_fr:	AWB filter response config. See ipu3_uapi_awb_fr_config
  * @ae:	auto exposure config  As specified by &ipu3_uapi_ae_config
-- 
2.34.1

Re: [PATCH] doc: ipu3: Fix UAPI header doc warnings

[Randy Dunlap]

On 1/28/24 14:52, Kohshi Yamaguchi wrote:
> The ipu3_uapi_acc_param struct in the IPU3 UAPI header mentioned
> reserved1 and reserved2 fields, which are absent in the actual
> structure definition. This mismatch led to Sphinx build warnings
> due to inconsistencies between the documentation and the code.
> 
> This patch removes these non-existent reserved field references
> from the documentation, resolving the Sphinx build warnings and
> ensuring the UAPI header is accurately documented.
> 
> Signed-off-by: Kohshi Yamaguchi <kohshi54.yam@gmail.com>
> ---
>  drivers/staging/media/ipu3/include/uapi/intel-ipu3.h | 2 --
>  1 file changed, 2 deletions(-)
> 
> diff --git a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> index caa358e0bae4..926fcf84e33c 100644
> --- a/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> +++ b/drivers/staging/media/ipu3/include/uapi/intel-ipu3.h
> @@ -2485,11 +2485,9 @@ struct ipu3_uapi_anr_config {
>   *		&ipu3_uapi_yuvp1_y_ee_nr_config
>   * @yds:	y down scaler config. See &ipu3_uapi_yuvp1_yds_config
>   * @chnr:	chroma noise reduction config. See &ipu3_uapi_yuvp1_chnr_config
> - * @reserved1: reserved
>   * @yds2:	y channel down scaler config. See &ipu3_uapi_yuvp1_yds_config
>   * @tcc:	total color correction config as defined in struct
>   *		&ipu3_uapi_yuvp2_tcc_static_config
> - * @reserved2: reserved
>   * @anr:	advanced noise reduction config.See &ipu3_uapi_anr_config
>   * @awb_fr:	AWB filter response config. See ipu3_uapi_awb_fr_config
>   * @ae:	auto exposure config  As specified by &ipu3_uapi_ae_config

posted 2 days ago:

https://lore.kernel.org/linux-media/eed7560f-cd7d-4e07-9b38-038ca65445bf@infradead.org/T/#mda377078e30cb5d784f23de95d8d7cca13265562

Thanks.

-- 
#Randy

Re: [PATCH] doc: ipu3: Fix UAPI header doc warnings

[Kohshi Yamaguchi]

Hi,

Thank you for reviewing my patch and pointing out the overlap.
I appreciate your feedback.

Best regards,
--
Kohshi Yamaguchi