Thread (12 messages) 12 messages, 3 authors, 2025-02-25

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

From: Simon Horman <horms@kernel.org>
Date: 2025-02-25 14:12:46
Also in: linux-arm-kernel, lkml, virtualization

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:
quoted
On Wed, Feb 19, 2025 at 08:32:57PM +0100, Peter Hilber wrote:

...
quoted
+/**
+ * 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.
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help