From: Greg KH <gregkh@linuxfoundation.org>
To: Jiri Slaby <jirislaby@kernel.org>
Cc: "D. Starke" <daniel.starke@siemens.com>,
linux-serial@vger.kernel.org, ilpo.jarvinen@linux.intel.com,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH v2 3/9] tty: n_gsm: add missing description to gsm_config
Date: Thu, 20 Apr 2023 13:11:58 +0200 [thread overview]
Message-ID: <ZEEd_oOvJYranmzN@kroah.com> (raw)
In-Reply-To: <2f2b20e4-34cd-a154-022f-c76c1b0e06c5@kernel.org>
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@siemens.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
next prev parent reply other threads:[~2023-04-20 11:17 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-04-20 8:50 [PATCH v2 1/9] tty: n_gsm: fix redundant assignment of gsm->encoding D. Starke
2023-04-20 8:50 ` [PATCH v2 2/9] tty: n_gsm: add restart parameter to DLC specific ioctl config D. Starke
2023-04-20 8:50 ` [PATCH v2 3/9] tty: n_gsm: add missing description to gsm_config D. Starke
2023-04-20 9:08 ` Jiri Slaby
2023-04-20 11:11 ` Greg KH [this message]
2023-04-20 8:50 ` [PATCH v2 4/9] tty: n_gsm: remove unneeded initialization of ret in gsm_dlci_config D. Starke
2023-04-20 8:50 ` [PATCH v2 5/9] tty: n_gsm: add open_error counter to gsm_mux D. Starke
2023-04-20 8:50 ` [PATCH v2 6/9] tty: n_gsm: increase malformed counter for malformed control frames D. Starke
2023-04-20 8:50 ` [PATCH v2 7/9] tty: n_gsm: increase gsm_mux unsupported counted where appropriate D. Starke
2023-04-20 8:50 ` [PATCH v2 8/9] tty: n_gsm: cleanup gsm_control_command and gsm_control_reply D. Starke
2023-04-20 8:50 ` [PATCH v2 9/9] tty: n_gsm: add DLCI specific rx/tx statistics D. Starke
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZEEd_oOvJYranmzN@kroah.com \
--to=gregkh@linuxfoundation.org \
--cc=daniel.starke@siemens.com \
--cc=ilpo.jarvinen@linux.intel.com \
--cc=jirislaby@kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-serial@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).