netdev - Re: [PATCH v5 2/4] virtio

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: <20250225141240.GW1615191@kernel.org>
Date: Tue, 25 Feb 2025 14:12:40 +0000
From: Simon Horman <horms@...nel.org>
To: Peter Hilber <quic_philber@...cinc.com>
Cc: "Michael S. Tsirkin" <mst@...hat.com>, Jason Wang <jasowang@...hat.com>,
	Trilok Soni <quic_tsoni@...cinc.com>,
	Srivatsa Vaddagiri <quic_svaddagi@...cinc.com>,
	Xuan Zhuo <xuanzhuo@...ux.alibaba.com>,
	Eugenio Pérez <eperezma@...hat.com>,
	Richard Cochran <richardcochran@...il.com>,
	linux-kernel@...r.kernel.org, virtualization@...ts.linux.dev,
	netdev@...r.kernel.org, David Woodhouse <dwmw2@...radead.org>,
	"Ridoux, Julien" <ridouxj@...zon.com>,
	Marc Zyngier <maz@...nel.org>, Mark Rutland <mark.rutland@....com>,
	Daniel Lezcano <daniel.lezcano@...aro.org>,
	Alexandre Belloni <alexandre.belloni@...tlin.com>,
	Parav Pandit <parav@...dia.com>,
	Matias Ezequiel Vara Larsen <mvaralar@...hat.com>,
	Cornelia Huck <cohuck@...hat.com>, virtio-dev@...ts.linux.dev,
	linux-arm-kernel@...ts.infradead.org
Subject: Re: [PATCH v5 2/4] virtio_rtc: Add PTP clocks

On Tue, Feb 25, 2025 at 12:28:24PM +0100, Peter Hilber wrote:
> On Mon, Feb 24, 2025 at 05:56:18PM +0000, Simon Horman wrote:
> > On Wed, Feb 19, 2025 at 08:32:57PM +0100, Peter Hilber wrote:
> > 
> > ...
> > 
> > > +/**
> > > + * viortc_ptp_gettimex64() - PTP clock gettimex64 op
> > > + *
> > 
> > Hi Peter,
> > 
> > Tooling recognises this as a kernel doc, and complains
> > that there is no documentation present for the function's
> > parameters: ptp, ts, and sts.
> > 
> > Flagged by W=1 builds.
> > 
> 
> Thanks, I will change the offending documentation to non kernel-doc. I
> was not aware that these warnings are always considered a problem.

Likewise, thanks.

I guess it depends on the subsystem. And perhaps this is fine for virtio.
But for Networking at large the rule of thumb is not to add new warnings.