Re: [PATCH] ioctl_tty.2: Document ioctls: TCGETS2, TCSETS2, TCSETSW2, TCSETSF2

["Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>]

Hi Pali,


On 7/26/21 12:55 AM, Pali Rohár wrote:
> Signed-off-by: Pali Rohár <pali@kernel.org>
> ---

Please see some comments below.

Thanks,

Alex

>   man2/ioctl_tty.2 | 29 +++++++++++++++++++++++++++++
>   1 file changed, 29 insertions(+)
> 
> diff --git a/man2/ioctl_tty.2 b/man2/ioctl_tty.2
> index c8269070180f..0c3a8ec24c76 100644
> --- a/man2/ioctl_tty.2
> +++ b/man2/ioctl_tty.2
> @@ -77,6 +77,35 @@ The following four ioctls are just like
>   .BR TCSETSW ,
>   .BR TCSETSF ,
>   except that they take a
> +.I "struct termios2\ *"
> +instead of a
> +.IR "struct termios\ *" .
> +.I "struct termios2\ *"
> +is defined in header file

Maybe s/in/in the/ ?

> +.IR "<asm/termbits.h>" .

Quotes are unnecessary here.

> +If struct member
> +.B c_cflag
> +contains
> +.B BOTHER
> +then baudrate is stored in struct members
> +.BR c_ispeed " and " c_ospeed

We always break this into:

.B c_ispeed
and
.B c_ospeed

> +as integer values.
> +These ioctls are not supported on all architectures.
> +.IP
> +.BI "TCGETS2	struct termios2 *" argp

Please follow the same style as in the rest of the page:

.TP
.B TCGETS2
Argument:
.BI "struct termios2 *" argp

Unless there's a good reason not to.

> +.IP
> +.BI "TCSETS2	const struct termios2 *" argp
> +.IP
> +.BI "TCSETSW2	const struct termios2 *" argp
> +.IP
> +.BI "TCSETSF2	const struct termios2 *" argp
> +.PP
> +The following four ioctls are just like
> +.BR TCGETS ,
> +.BR TCSETS ,
> +.BR TCSETSW ,
> +.BR TCSETSF ,
> +except that they take a
>   .I "struct termio\ *"
>   instead of a
>   .IR "struct termios\ *" .
> 


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