linux-kernel - Re: [PATCH net-next v4] ptp: add Alibaba CIPU PTP clock driver

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: <20250818090519.33335d5e@kernel.org>
Date: Mon, 18 Aug 2025 09:05:19 -0700
From: Jakub Kicinski <kuba@...nel.org>
To: Wen Gu <guwen@...ux.alibaba.com>
Cc: richardcochran@...il.com, andrew+netdev@...n.ch, davem@...emloft.net,
 edumazet@...gle.com, pabeni@...hat.com, xuanzhuo@...ux.alibaba.com,
 dust.li@...ux.alibaba.com, netdev@...r.kernel.org,
 linux-kernel@...r.kernel.org, Thomas Gleixner <tglx@...utronix.de>, David
 Woodhouse <dwmw2@...radead.org>
Subject: Re: [PATCH net-next v4] ptp: add Alibaba CIPU PTP clock driver

On Sat, 16 Aug 2025 11:52:18 +0800 Wen Gu wrote:
> > This driver is lacking documentation. You need to describe how the user
> > is expected to interact with the device and document all these sysfs
> > attributes.
> >   
> 
> OK. I will add the description.
> 
> Would you prefer me to create a related .rst file under Documentation/
> (perhaps in a new Documentation/clock/ptp/ directory?), or add the
> description comments directly in this driver source?

It's supposed to be user-facing documentation, so Documentation.

But you ignored David Woodhouse's response, and also skirted around
Andrew's comment on OS kernel being an abstraction layer. So if you
plan to post a v5 -- the documentation better clearly explain why
this is a PTP device, and not a real time clock.