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

Michael Kerrisk (man-pages)
2021-08-08T20:57:04Z

Hello Pali and Alex,

On 8/8/21 10:41 AM, Alejandro Colomar wrote:
> From: Pali Rohár <pali@kernel.org>
>
> Signed-off-by: Pali Rohár <pali@kernel.org>
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
> ---
> man2/ioctl_tty.2 | 29 +++++++++++++++++++++++++++++
> 1 file changed, 29 insertions(+)
>
> diff --git a/man2/ioctl_tty.2 b/man2/ioctl_tty.2
> index 46294e63f..967b5c4c7 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\ *" .
> +If struct member
> +.B c_cflag
> +contains
> +.B BOTHER
> +then baudrate is stored in struct members
> +.B c_ispeed
> +and
> +.B c_ospeed
> +as integer values.
> +These ioctls are not supported on all architectures.
> +.RS
> +.TS
> +lb l.
> +TCGETS2 \fBstruct termios2 *\fPargp
> +TCSETS2 \fBconst struct termios2 *\fPargp
> +TCSETSW2 \fBconst struct termios2 *\fPargp
> +TCSETSF2 \fBconst struct termios2 *\fPargp
> +.TE
> +.RE
> +.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\ *" .

The Linux man-pages generally try to maintain historical and
version info (at least back as far as 2.6.0), so I applied
the patch below.

Thanks,

Michael

commit 48a486dddefa20cddbc83610cf582acecf23e2b3 (HEAD -> master)
Author: Michael Kerrisk <mtk.manpages@gmail.com>
Date: Sun Aug 8 22:54:29 2021 +0200

ioctl_tty.2: Note kernel version that added TCGETS2, TCSETS2, TCSETSW2, and TCSETSF2

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>

diff --git a/man2/ioctl_tty.2 b/man2/ioctl_tty.2
index 9854cfd3f..1d9a6dee1 100644
--- a/man2/ioctl_tty.2
+++ b/man2/ioctl_tty.2
@@ -71,7 +71,10 @@ Equivalent to
Allow the output buffer to drain, discard pending input, and
set the current serial port settings.
.PP
-The following four ioctls are just like
+The following four ioctls, added in Linux 2.6.20,
+.\" commit 64bb6c5e1ddcd47c951740485026ef08975ee2e6
+.\" commit 592ee3a5e5e2a981ef2829a0380093006d045661
+are just like
.BR TCGETS ,
.BR TCSETS ,
.BR TCSETSW ,

--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/