Re: [PATCH v5 2/4] virtio_rtc: Add PTP clocks

Peter Hilber <[email protected]> Tue, 25 Feb 2025 12:28:24 +0100
Newsgroups dev.linux.lists.virtio-dev,dev.linux.lists.virtualization,org.infradead.lists.linux-arm-kernel,org.kernel.vger.linux-kernel,org.kernel.vger.netdev
Message-ID <vhlhes7wepjrtfo6qsnw5tmtvw6pdt2tfi4woqdejlit5ruczj@4cs2yvffhx74>
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.

Peter

> > + * Context: Process context.
> > + */
> > +static int viortc_ptp_gettimex64(struct ptp_clock_info *ptp,
> > +				 struct timespec64 *ts,
> > +				 struct ptp_system_timestamp *sts)
> 
> ...