linux-kernel - Re: [RFC 2/3] Documentation pps.rst: add PPS generators documentation

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: <2024100932-twirl-stabilize-8574@gregkh>
Date: Wed, 9 Oct 2024 11:14:53 +0200
From: Greg KH <greg@...ah.com>
To: Rodolfo Giometti <giometti@...eenne.com>
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
	Andrew Morton <akpm@...ux-foundation.org>, corbet@....net,
	Hall Christopher S <christopher.s.hall@...el.com>,
	Mohan Subramanian <subramanian.mohan@...el.com>, tglx@...utronix.de,
	andriy.shevchenko@...ux.intel.com,
	Dong Eddie <eddie.dong@...el.com>, N Pandith <pandith.n@...el.com>,
	T R Thejesh Reddy <thejesh.reddy.t.r@...el.com>,
	Zage David <david.zage@...el.com>,
	Chinnadurai Srinivasan <srinivasan.chinnadurai@...el.com>
Subject: Re: [RFC 2/3] Documentation pps.rst: add PPS generators documentation

On Wed, Oct 09, 2024 at 10:48:18AM +0200, Rodolfo Giometti wrote:
> On 08/10/24 17:43, Greg KH wrote:
> > On Tue, Oct 08, 2024 at 03:50:32PM +0200, Rodolfo Giometti wrote:
> > > This patch adds some examples about how to register a new PPS
> > > generator in the system, and how to manage it.
> > > 
> > > Signed-off-by: Rodolfo Giometti <giometti@...eenne.com>
> > > ---
> > >   Documentation/driver-api/pps.rst | 40 ++++++++++++++++++++++++++++++++
> > 
> > All of this can go into the .c file and autogenerated there, no need for
> > a separate .rst file that will quickly get out-of-date.
> 
> I see. I'm going to add proper documentation within .c files. But since some
> references about PPS generators are also present in this file, I think it
> would be wise to add some notes about the new interface...

Why not just move all of the documentation into the .c files?

thanks,

greg k-h