Re: [PATCH v2 3/9] tty: n_gsm: add missing description to gsm_config

From: Greg KH
Date: Thu Apr 20 2023 - 07:17:26 EST


On Thu, Apr 20, 2023 at 11:08:32AM +0200, Jiri Slaby wrote:
> On 20. 04. 23, 10:50, D. Starke wrote:
> > From: Daniel Starke <daniel.starke@xxxxxxxxxxx>
> >
> > Currently, all available structure fields in gsmmux.h except those
> > for gsm_config are commented.
> >
> > Fix this by adding appropriate comments to the not commented fields.
> > Note that 'mru' and 'mtu' refer to the size without basic/advanced option
> > mode header and byte stuffing as defined in the standard in chapter 5.7.2.
>
> Maybe you can start documenting them using kernel-doc? And convert the
> others and expose them all to Documentation and finally to:
> https://www.kernel.org/doc/html/latest/
> ?

I agree, this should be done in kerneldoc format please.

thanks,

greg k-h