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

Greg KH
2024-10-09T09:14:57Z

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@enneenne.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