linux-kernel - Re: [PATCH 06/17] media: i2c: css-quirk.h: Fix kerneldoc

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: <d757c5a7-bb3c-4dd9-bac4-e43ee7685a18@infradead.org>
Date: Sat, 27 Jan 2024 14:00:34 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Ricardo Ribalda <ribalda@...omium.org>,
 Tiffany Lin <tiffany.lin@...iatek.com>,
 Andrew-CT Chen <andrew-ct.chen@...iatek.com>,
 Yunfei Dong <yunfei.dong@...iatek.com>,
 Mauro Carvalho Chehab <mchehab@...nel.org>,
 Matthias Brugger <matthias.bgg@...il.com>,
 AngeloGioacchino Del Regno <angelogioacchino.delregno@...labora.com>,
 Sakari Ailus <sakari.ailus@...ux.intel.com>,
 Laurent Pinchart <laurent.pinchart@...asonboard.com>,
 Hans Verkuil <hverkuil-cisco@...all.nl>, Hans Verkuil <hverkuil@...all.nl>,
 Kieran Bingham <kieran.bingham@...asonboard.com>,
 Bin Liu <bin.liu@...iatek.com>,
 Ezequiel Garcia <ezequiel@...guardiasur.com.ar>,
 Philipp Zabel <p.zabel@...gutronix.de>,
 Stanimir Varbanov <stanimir.k.varbanov@...il.com>,
 Vikash Garodia <quic_vgarodia@...cinc.com>,
 Bryan O'Donoghue <bryan.odonoghue@...aro.org>,
 Bjorn Andersson <andersson@...nel.org>,
 Konrad Dybcio <konrad.dybcio@...aro.org>,
 Sylwester Nawrocki <s.nawrocki@...sung.com>,
 Krzysztof Kozlowski <krzysztof.kozlowski@...aro.org>,
 Alim Akhtar <alim.akhtar@...sung.com>,
 Marek Szyprowski <m.szyprowski@...sung.com>,
 Andrzej Hajda <andrzej.hajda@...el.com>, Bingbu Cao <bingbu.cao@...el.com>,
 Tianshu Qiu <tian.shu.qiu@...el.com>,
 Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
 Neil Armstrong <neil.armstrong@...aro.org>,
 Kevin Hilman <khilman@...libre.com>, Jerome Brunet <jbrunet@...libre.com>,
 Martin Blumenstingl <martin.blumenstingl@...glemail.com>
Cc: linux-media@...r.kernel.org, linux-kernel@...r.kernel.org,
 linux-arm-kernel@...ts.infradead.org, linux-mediatek@...ts.infradead.org,
 linux-rockchip@...ts.infradead.org, linux-arm-msm@...r.kernel.org,
 linux-samsung-soc@...r.kernel.org, linux-staging@...ts.linux.dev,
 linux-amlogic@...ts.infradead.org
Subject: Re: [PATCH 06/17] media: i2c: css-quirk.h: Fix kerneldoc



On 1/26/24 15:16, Ricardo Ribalda wrote:
> Kerneldoc does not seem to understand that embed doc:
> drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'write' description in 'ccs_quirk'
> drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'reg' description in 'ccs_quirk'
> drivers/media/i2c/ccs/ccs-quirk.h:50: warning: Excess struct member 'val' description in 'ccs_quirk'
> 

Correct. It's never tried to understand that AFAIK.

> Convert into a standard doc.
> 
> Signed-off-by: Ricardo Ribalda <ribalda@...omium.org>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>

Thanks.

> ---
>  drivers/media/i2c/ccs/ccs-quirk.h | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/media/i2c/ccs/ccs-quirk.h b/drivers/media/i2c/ccs/ccs-quirk.h
> index 0b1a64958d71..392c97109617 100644
> --- a/drivers/media/i2c/ccs/ccs-quirk.h
> +++ b/drivers/media/i2c/ccs/ccs-quirk.h
> @@ -28,11 +28,11 @@ struct ccs_sensor;
>   * @reg_access: Register access quirk. The quirk may divert the access
>   *		to another register, or no register at all.
>   *
> - *		@write: Is this read (false) or write (true) access?
> - *		@reg: Pointer to the register to access
> - *		@value: Register value, set by the caller on write, or
> + *		-write: Is this read (false) or write (true) access?
> + *		-reg:   Pointer to the register to access
> + *		-val:   Register value, set by the caller on write, or
>   *			by the quirk on read
> - *		@return: 0 on success, -ENOIOCTLCMD if no register
> + *		-return: 0 on success, -ENOIOCTLCMD if no register
>   *			 access may be done by the caller (default read
>   *			 value is zero), else negative error code on error
>   * @flags: Quirk flags
> 

-- 
#Randy