[PATCH] termios.3: Add information how to set baudrate to any other value

[PATCH] termios.3: Add information how to set baudrate to any other value

[Pali Rohár]

Signed-off-by: Pali Rohár <pali@kernel.org>
---
 man3/termios.3 | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/man3/termios.3 b/man3/termios.3
index b7cdec507524..4d4593a33c32 100644
--- a/man3/termios.3
+++ b/man3/termios.3
@@ -967,6 +967,12 @@ Normally, this will disconnect the line.
 \fBCBAUDEX\fP is a mask
 for the speeds beyond those defined in POSIX.1 (57600 and above).
 Thus, \fBB57600\fP & \fBCBAUDEX\fP is nonzero.
+Setting baudrate to other value than defined by
+.B Bnnn
+constants is possible via
+.B TCSETS2
+ioctl, see
+.BR ioctl_tty (2).
 .PP
 .BR cfgetispeed ()
 returns the input baud rate stored in the \fItermios\fP structure.
-- 
2.20.1

Re: [PATCH] termios.3: Add information how to set baudrate to any other value

[Alejandro Colomar (man-pages)]

Hi Pali,

On 7/30/21 5:30 PM, Pali Rohár wrote:
> Signed-off-by: Pali Rohár <pali@kernel.org>

Please see some comments below.

Thanks,

Alex

> ---
>   man3/termios.3 | 6 ++++++
>   1 file changed, 6 insertions(+)
> 
> diff --git a/man3/termios.3 b/man3/termios.3
> index b7cdec507524..4d4593a33c32 100644
> --- a/man3/termios.3
> +++ b/man3/termios.3
> @@ -967,6 +967,12 @@ Normally, this will disconnect the line.
>   \fBCBAUDEX\fP is a mask
>   for the speeds beyond those defined in POSIX.1 (57600 and above).
>   Thus, \fBB57600\fP & \fBCBAUDEX\fP is nonzero.

I think this should go on a separate paragraph, don't you?

.PP?

> +Setting baudrate to other value than defined by

wfix?:

Setting the baud rate to a value other that those defined by

> +.B Bnnn
> +constants is possible via

s/via/via the/?

> +.B TCSETS2
> +ioctl, see

s/,/;/

> +.BR ioctl_tty (2).
>   .PP
>   .BR cfgetispeed ()
>   returns the input baud rate stored in the \fItermios\fP structure.
> 


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

[PATCH v2] termios.3: Add information how to set baud rate to any other value

[Pali Rohár]

Signed-off-by: Pali Rohár <pali@kernel.org>
---
 man3/termios.3 | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/man3/termios.3 b/man3/termios.3
index b7cdec507524..7b195c95912b 100644
--- a/man3/termios.3
+++ b/man3/termios.3
@@ -968,6 +968,13 @@ Normally, this will disconnect the line.
 for the speeds beyond those defined in POSIX.1 (57600 and above).
 Thus, \fBB57600\fP & \fBCBAUDEX\fP is nonzero.
 .PP
+Setting the baud rate to a value other that those defined by
+.B Bnnn
+constants is possible via the
+.B TCSETS2
+ioctl; see
+.BR ioctl_tty (2).
+.PP
 .BR cfgetispeed ()
 returns the input baud rate stored in the \fItermios\fP structure.
 .PP
-- 
2.20.1

Re: [PATCH v2] termios.3: Add information how to set baud rate to any other value

[Alejandro Colomar (man-pages)]

Hi Pali,

On 7/30/21 8:45 PM, Pali Rohár wrote:
> Signed-off-by: Pali Rohár <pali@kernel.org>

Patch applied.  Thanks,

Alex

> ---
>   man3/termios.3 | 7 +++++++
>   1 file changed, 7 insertions(+)
> 
> diff --git a/man3/termios.3 b/man3/termios.3
> index b7cdec507524..7b195c95912b 100644
> --- a/man3/termios.3
> +++ b/man3/termios.3
> @@ -968,6 +968,13 @@ Normally, this will disconnect the line.
>   for the speeds beyond those defined in POSIX.1 (57600 and above).
>   Thus, \fBB57600\fP & \fBCBAUDEX\fP is nonzero.
>   .PP
> +Setting the baud rate to a value other that those defined by
> +.B Bnnn
> +constants is possible via the
> +.B TCSETS2
> +ioctl; see
> +.BR ioctl_tty (2).
> +.PP
>   .BR cfgetispeed ()
>   returns the input baud rate stored in the \fItermios\fP structure.
>   .PP
> 


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

Re: [PATCH v2] termios.3: Add information how to set baud rate to any other value

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 268 bytes --]

Hi, Pali!

At 2021-07-30T20:45:36+0200, Pali Rohár wrote:
> +Setting the baud rate to a value other that those defined by
> +.B Bnnn
> +constants is possible via the

I'd say

.BI B nnn

because the "nnn" is not literal, but variable.

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH] termios.3: Add information how to set baudrate to any other value

[G. Branden Robinson]

[-- Attachment #1: Type: text/plain, Size: 1206 bytes --]

Hi, Pali & Alex!

At 2021-07-30T20:29:24+0200, Alejandro Colomar (man-pages) wrote:
> >   for the speeds beyond those defined in POSIX.1 (57600 and above).
> >   Thus, \fBB57600\fP & \fBCBAUDEX\fP is nonzero.
> 
> I think this should go on a separate paragraph, don't you?

I would line break after the comma, quote the multiword literal in case
the bold attribute gets stripped out of the output (copying and
pasting man page text into emails, for instance), and use font style
macros instead of font selection escape sequences.

> .PP?
> 
> > +Setting baudrate to other value than defined by
> 
> wfix?:
> 
> Setting the baud rate to a value other that those defined by

I'd say "baud rate" as two words in English prose (contrast with C), but
"than" is correct.

> > +.B Bnnn
> > +constants is possible via
> 
> s/via/via the/?

I agree.

> 
> > +.B TCSETS2
> > +ioctl, see
> 
> s/,/;/

I agree.  Comma splices are evil.

Incidentally, when checking for semantic newline issues, I use the
following search pattern in Vim.

/[.;:].

Strictly, I should say

/[.;:!?][^\\]

and were to bind that to a key, that's probably what I'd use.

Regards,
Branden

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

Re: [PATCH v2] termios.3: Add information how to set baud rate to any other value

[Alejandro Colomar (man-pages)]

Hi Branden,

On 7/31/21 2:19 AM, G. Branden Robinson wrote:
> Hi, Pali!
> 
> At 2021-07-30T20:45:36+0200, Pali Rohár wrote:
>> +Setting the baud rate to a value other that those defined by
>> +.B Bnnn
>> +constants is possible via the
> 
> I'd say
> 
> .BI B nnn
> 
> because the "nnn" is not literal, but variable.

Agree.

But as I already merged the patch, I'll add a new patch with that 
change.  Moreover, man pages mostly-consistently use .B Bnn style 
(although incorrectly, from reading groff_man(7)), so it deserves a 
separate patch.

Thanks,

Ale

> 
> Regards,
> Branden
> 


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

Re: [PATCH v2] termios.3: Add information how to set baud rate to any other value

[Pali Rohár]

On Saturday 31 July 2021 13:04:50 Alejandro Colomar (man-pages) wrote:
> Hi Branden,
> 
> On 7/31/21 2:19 AM, G. Branden Robinson wrote:
> > Hi, Pali!
> > 
> > At 2021-07-30T20:45:36+0200, Pali Rohár wrote:
> > > +Setting the baud rate to a value other that those defined by
> > > +.B Bnnn
> > > +constants is possible via the
> > 
> > I'd say
> > 
> > .BI B nnn
> > 
> > because the "nnn" is not literal, but variable.
> 
> Agree.
> 
> But as I already merged the patch, I'll add a new patch with that change.
> Moreover, man pages mostly-consistently use .B Bnn style (although
> incorrectly, from reading groff_man(7)), so it deserves a separate patch.

Makes sense. Would you fix style on all places ('git grep Bnn')?

> Thanks,
> 
> Ale
> 
> > 
> > Regards,
> > Branden
> > 
> 
> 
> -- 
> Alejandro Colomar
> Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
> http://www.alejandro-colomar.es/

Re: [PATCH] termios.3: Add information how to set baudrate to any other value

[Alejandro Colomar (man-pages)]

Hi Branden,

On 7/31/21 3:50 AM, G. Branden Robinson wrote:
> Hi, Pali & Alex!
> 
> At 2021-07-30T20:29:24+0200, Alejandro Colomar (man-pages) wrote:
>>>    for the speeds beyond those defined in POSIX.1 (57600 and above).
>>>    Thus, \fBB57600\fP & \fBCBAUDEX\fP is nonzero.
>>
>> I think this should go on a separate paragraph, don't you?
> 
> I would line break after the comma, quote the multiword literal in case
> the bold attribute gets stripped out of the output (copying and
> pasting man page text into emails, for instance), and use font style
> macros instead of font selection escape sequences.

I would too, but that was already existing text that was out of the 
scope of this patch :/

> 
>> .PP?
>>
>>> +Setting baudrate to other value than defined by
>>
>> wfix?:
>>
>> Setting the baud rate to a value other that those defined by
> 
> I'd say "baud rate" as two words in English prose (contrast with C), but
> "than" is correct.

Ouch!  I meant "than"; "that" was a typo that I introduced.  As I 
already applied the patch, I'll fix it myself in my tree before sending 
it to Michael.

Thanks,

Alex

> 
>>> +.B Bnnn
>>> +constants is possible via
>>
>> s/via/via the/?
> 
> I agree.
> 
>>
>>> +.B TCSETS2
>>> +ioctl, see
>>
>> s/,/;/
> 
> I agree.  Comma splices are evil.
> 
> Incidentally, when checking for semantic newline issues, I use the
> following search pattern in Vim.
> 
> /[.;:].
> 
> Strictly, I should say
> 
> /[.;:!?][^\\]
> 
> and were to bind that to a key, that's probably what I'd use.
> 
> Regards,
> Branden
> 


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/

Re: [PATCH v2] termios.3: Add information how to set baud rate to any other value

[Alejandro Colomar (man-pages)]

Hi Pali,


On 7/31/21 1:06 PM, Pali Rohár wrote:
> On Saturday 31 July 2021 13:04:50 Alejandro Colomar (man-pages) wrote:
>> Hi Branden,
>>
>> On 7/31/21 2:19 AM, G. Branden Robinson wrote:
>>> Hi, Pali!
>>>
>>> At 2021-07-30T20:45:36+0200, Pali Rohár wrote:
>>>> +Setting the baud rate to a value other that those defined by
>>>> +.B Bnnn
>>>> +constants is possible via the
>>>
>>> I'd say
>>>
>>> .BI B nnn
>>>
>>> because the "nnn" is not literal, but variable.
>>
>> Agree.
>>
>> But as I already merged the patch, I'll add a new patch with that change.
>> Moreover, man pages mostly-consistently use .B Bnn style (although
>> incorrectly, from reading groff_man(7)), so it deserves a separate patch.
> 
> Makes sense. Would you fix style on all places ('git grep Bnn')?

I fixed it right now for Bnnn: 
<https://github.com/alejandro-colomar/man-pages/commit/e505393f80d040a03f3c2955e0d236c8e109ee6e>

I'll try to fix it for every other case of FOO* in the pages soon.


Regards,

Alex


-- 
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/