From: "Michael S. Tsirkin" <mst@redhat.com>
To: Simon Horman <horms@kernel.org>
Cc: "Peter Hilber" <quic_philber@quicinc.com>,
"Jason Wang" <jasowang@redhat.com>,
"Trilok Soni" <quic_tsoni@quicinc.com>,
"Srivatsa Vaddagiri" <quic_svaddagi@quicinc.com>,
"Xuan Zhuo" <xuanzhuo@linux.alibaba.com>,
"Eugenio Pérez" <eperezma@redhat.com>,
"Richard Cochran" <richardcochran@gmail.com>,
linux-kernel@vger.kernel.org, virtualization@lists.linux.dev,
netdev@vger.kernel.org, "David Woodhouse" <dwmw2@infradead.org>,
"Ridoux, Julien" <ridouxj@amazon.com>,
"Marc Zyngier" <maz@kernel.org>,
"Mark Rutland" <mark.rutland@arm.com>,
"Daniel Lezcano" <daniel.lezcano@linaro.org>,
"Alexandre Belloni" <alexandre.belloni@bootlin.com>,
"Parav Pandit" <parav@nvidia.com>,
"Matias Ezequiel Vara Larsen" <mvaralar@redhat.com>,
"Cornelia Huck" <cohuck@redhat.com>,
virtio-dev@lists.linux.dev, linux-arm-kernel@lists.infradead.org
Subject: Re: [PATCH v5 2/4] virtio_rtc: Add PTP clocks
Date: Tue, 25 Feb 2025 09:21:24 -0500 [thread overview]
Message-ID: <20250225092115-mutt-send-email-mst@kernel.org> (raw)
In-Reply-To: <20250225141240.GW1615191@kernel.org>
On Tue, Feb 25, 2025 at 02:12:40PM +0000, Simon Horman wrote:
> 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.
Nope.
next prev parent reply other threads:[~2025-02-25 14:21 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-02-19 19:32 [PATCH v5 0/4] Add virtio_rtc module Peter Hilber
2025-02-19 19:32 ` [PATCH v5 1/4] virtio_rtc: Add module and driver core Peter Hilber
2025-02-24 17:55 ` Simon Horman
2025-02-25 12:25 ` Peter Hilber
2025-02-19 19:32 ` [PATCH v5 2/4] virtio_rtc: Add PTP clocks Peter Hilber
2025-02-24 17:56 ` Simon Horman
2025-02-25 11:28 ` Peter Hilber
2025-02-25 14:12 ` Simon Horman
2025-02-25 14:21 ` Michael S. Tsirkin [this message]
2025-02-19 19:32 ` [PATCH v5 3/4] virtio_rtc: Add Arm Generic Timer cross-timestamping Peter Hilber
2025-02-25 12:18 ` [PATCH v5 0/4] Add virtio_rtc module Michael S. Tsirkin
2025-02-25 12:34 ` Peter Hilber
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20250225092115-mutt-send-email-mst@kernel.org \
--to=mst@redhat.com \
--cc=alexandre.belloni@bootlin.com \
--cc=cohuck@redhat.com \
--cc=daniel.lezcano@linaro.org \
--cc=dwmw2@infradead.org \
--cc=eperezma@redhat.com \
--cc=horms@kernel.org \
--cc=jasowang@redhat.com \
--cc=linux-arm-kernel@lists.infradead.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mark.rutland@arm.com \
--cc=maz@kernel.org \
--cc=mvaralar@redhat.com \
--cc=netdev@vger.kernel.org \
--cc=parav@nvidia.com \
--cc=quic_philber@quicinc.com \
--cc=quic_svaddagi@quicinc.com \
--cc=quic_tsoni@quicinc.com \
--cc=richardcochran@gmail.com \
--cc=ridouxj@amazon.com \
--cc=virtio-dev@lists.linux.dev \
--cc=virtualization@lists.linux.dev \
--cc=xuanzhuo@linux.alibaba.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).