Re: [PATCH] tty: n_gsm: modify the doc punctuation "," to "."

From: Greg KH
Date: Thu Jun 24 2021 - 09:00:03 EST


On Fri, Jun 18, 2021 at 10:03:31AM +0800, Zhenguo Zhao wrote:
> From: Zhenguo Zhao <Zhenguo.Zhao1@xxxxxxxxxx>
>
> End punctuation of items 5 and 6 are ".",other lists
> should be modify to "."
>
> Signed-off-by: Zhenguo Zhao <Zhenguo.Zhao1@xxxxxxxxxx>
> ---
> Documentation/driver-api/serial/n_gsm.rst | 8 ++++----
> 1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/driver-api/serial/n_gsm.rst b/Documentation/driver-api/serial/n_gsm.rst
> index 87dfcd5..154c75e 100644
> --- a/Documentation/driver-api/serial/n_gsm.rst
> +++ b/Documentation/driver-api/serial/n_gsm.rst
> @@ -14,11 +14,11 @@ How to use it
> -------------
> 1. initialize the modem in 0710 mux mode (usually AT+CMUX= command) through
> its serial port. Depending on the modem used, you can pass more or less
> - parameters to this command,
> + parameters to this command.
> 2. switch the serial line to using the n_gsm line discipline by using
> - TIOCSETD ioctl,
> -3. configure the mux using GSMIOC_GETCONF / GSMIOC_SETCONF ioctl,
> -4. obtain base gsmtty number for the used serial port,
> + TIOCSETD ioctl.
> +3. configure the mux using GSMIOC_GETCONF / GSMIOC_SETCONF ioctl.
> +4. obtain base gsmtty number for the used serial port.
>

Strangly, the use of a ',' here is correct as this is a list of things
to do in a specific order. If you wrote this all out at once in a
single sentance without the numbers, a ',' would make sense.

But this isn't a big deal, if you want to use '.' then please capitalize
the first word of each item in the list.

Picky, yes, sorry.

greg k-h