linux-kernel - Re: [PATCH] doc: ipu3: Fix UAPI header doc warnings

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <621fe651-8538-43d5-a797-c1e66436b2dc@infradead.org>
Date: Sun, 28 Jan 2024 15:21:01 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Kohshi Yamaguchi <kohshi54.yam@...il.com>, sakari.ailus@...ux.intel.com,
 bingbu.cao@...el.com, tian.shu.qiu@...el.com
Cc: mchehab@...nel.org, gregkh@...uxfoundation.org,
 linux-media@...r.kernel.org, linux-staging@...ts.linux.dev,
 linux-kernel@...r.kernel.org, skhan@...uxfoundation.org
Subject: Re: [PATCH] doc: ipu3: Fix UAPI header doc warnings


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@...il.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