linux-kernel - Re: [PATCH v2 3/9] tty: n_gsm: add missing description to gsm

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] [day] [month] [year] [list]

Date:   Thu, 20 Apr 2023 13:11:58 +0200
From:   Greg KH <gregkh@...uxfoundation.org>
To:     Jiri Slaby <jirislaby@...nel.org>
Cc:     "D. Starke" <daniel.starke@...mens.com>,
        linux-serial@...r.kernel.org, ilpo.jarvinen@...ux.intel.com,
        linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2 3/9] tty: n_gsm: add missing description to gsm_config

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@...mens.com>
> > 
> > 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