Re: [PATCH misc] misc: Add Renesas Synchronization Management Unit (SMU) support

[Randy Dunlap]

On 9/14/21 10:38 PM, Greg KH wrote:
> On Tue, Sep 14, 2021 at 08:43:44PM +0000, Min Li wrote:
> > Hi Greg
> >
> > Thanks for the review
> >
> > > >   drivers/misc/Kconfig      |   9 ++
> > > >   drivers/misc/Makefile     |   2 +
> > > >   drivers/misc/rsmu_cdev.c  | 239
> > > > ++++++++++++++++++++++++++++++++++++++++++++++
> > > >   drivers/misc/rsmu_cdev.h  |  77 +++++++++++++++
> > > >   drivers/misc/rsmu_cm.c    | 164 +++++++++++++++++++++++++++++++
> > > >   drivers/misc/rsmu_sabre.c | 133 ++++++++++++++++++++++++++
> > >
> > > If you make this all one .c file, the .h file can go away and it will be much
> > > simpler in the end.  And will get rid of the global symbols.

> > > > +
> > > > +/**
> > > > + * @Description
> > >
> > > What is this format?  It is not kernel-doc :(
> > >
> > > > + * ioctl to set SMU combo mode.Combo mode provides physical layer
> > > > + frequency
> > > > + * support from the Ethernet Equipment Clock to the PTP clock
> > > > + *
> > > > + * @Parameters
> > >
> > > Same here and elsewhere in this file.
> >
> > I was copying the format from xilinx_sdfec.h
> >
> > Is there a place that tells me how to properly document ioctl or can you give me an code example?
>
> The kerneldoc format should be described in Documentation/ somewhere...

See Documentation/doc-guide/kernel-doc.rst.

--
~Randy