linux-kernel - Re: [PATCH 03/17] media: media-entity.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: <ZbVOGaw-8qU2QNle@kekkonen.localdomain>
Date: Sat, 27 Jan 2024 18:40:25 +0000
From: Sakari Ailus <sakari.ailus@...ux.intel.com>
To: Randy Dunlap <rdunlap@...radead.org>
Cc: 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>,
	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>,
	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 03/17] media: media-entity.h: Fix kerneldoc

Hi Randy,

On Fri, Jan 26, 2024 at 05:51:06PM -0800, Randy Dunlap wrote:
> 
> 
> On 1/26/24 15:16, Ricardo Ribalda wrote:
> > The fields seems to be documented twice.
> > 
> > Signed-off-by: Ricardo Ribalda <ribalda@...omium.org>
> > ---
> >  include/media/media-entity.h | 4 ----
> >  1 file changed, 4 deletions(-)
> > 
> > diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> > index 2b6cd343ee9e..c79176ed6299 100644
> > --- a/include/media/media-entity.h
> > +++ b/include/media/media-entity.h
> > @@ -337,10 +337,6 @@ enum media_entity_type {
> >   * @info.dev:	Contains device major and minor info.
> >   * @info.dev.major: device node major, if the device is a devnode.
> >   * @info.dev.minor: device node minor, if the device is a devnode.
> > - * @major:	Devnode major number (zero if not applicable). Kept just
> > - *		for backward compatibility.
> > - * @minor:	Devnode minor number (zero if not applicable). Kept just
> > - *		for backward compatibility.
> >   *
> >   * .. note::
> >   *
> > 
> 
> I'd say that this is correct based on
> https://patchwork.kernel.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/
> 
> 
> Hans, can you please explain this message from you, on 2024-Jan-22, that
> I cannot find in the media patchwork:

It's in linuxtv.org Patchwork here
<URL:https://patchwork.linuxtv.org/project/linux-media/patch/20231223050707.14091-1-rdunlap@infradead.org/>
and also in the media stage tree (as indicated by the state) but not yet in
master AFAIU.

> 
> 
> Subject: [git:media_stage/master] media: media-entity.h: fix Excess kernel-doc description warnings
> 
> 
> 
> This is an automatic generated email to let you know that the following patch were queued:
> 
> Subject: media: media-entity.h: fix Excess kernel-doc description warnings
> Author:  Randy Dunlap <rdunlap@...radead.org>
> Date:    Fri Dec 22 21:07:07 2023 -0800
> 
> Remove the @major: and @minor: lines to prevent the kernel-doc warnings:
> 
> include/media/media-entity.h:376: warning: Excess struct member 'major' description in 'media_entity'
> include/media/media-entity.h:376: warning: Excess struct member 'minor' description in 'media_entity'
> 
> Signed-off-by: Randy Dunlap <rdunlap@...radead.org>
> Reviewed-by: Laurent Pinchart <laurent.pinchart@...asonboard.com>
> Signed-off-by: Sakari Ailus <sakari.ailus@...ux.intel.com>
> Signed-off-by: Hans Verkuil <hverkuil-cisco@...all.nl>
> 
>  include/media/media-entity.h | 4 ----
>  1 file changed, 4 deletions(-)
> 
> ---
> 
> diff --git a/include/media/media-entity.h b/include/media/media-entity.h
> index 2b6cd343ee9e..c79176ed6299 100644
> --- a/include/media/media-entity.h
> +++ b/include/media/media-entity.h
> @@ -337,10 +337,6 @@ enum media_entity_type {
>   * @info.dev:	Contains device major and minor info.
>   * @info.dev.major: device node major, if the device is a devnode.
>   * @info.dev.minor: device node minor, if the device is a devnode.
> - * @major:	Devnode major number (zero if not applicable). Kept just
> - *		for backward compatibility.
> - * @minor:	Devnode minor number (zero if not applicable). Kept just
> - *		for backward compatibility.
>   *
>   * .. note::
>   *
> 
> 
> 
> Thanks.

-- 
Regards,

Sakari Ailus