From: "Alejandro Colomar \(man-pages\) via Libc-alpha" <libc-alpha@sourceware.org>
To: "Pali Rohár" <pali@kernel.org>
Cc: "Marek Behún" <kabel@kernel.org>,
"G. Branden Robinson" <g.branden.robinson@gmail.com>,
libc-alpha@sourceware.org,
"Michael Kerrisk" <mtk.manpages@gmail.com>,
linux-man@vger.kernel.org
Subject: Re: [PATCH] ioctl_tty.2: Fix information about header include file
Date: Fri, 30 Jul 2021 14:02:00 +0200 [thread overview]
Message-ID: <f521c025-e219-fa72-505b-5bec149446cf@gmail.com> (raw)
In-Reply-To: <20210730105353.10424-1-pali@kernel.org>
Hi Pali,
On 7/30/21 12:53 PM, Pali Rohár wrote:
> Header file termios.h contains incompatible definitions for linux ioctl
> calls. Correct definitions are exported by header file linux/termios.h but
> this file conflicts with sys/ioctl.h header file (required for ioctl()
> call). Therefore include direct asm header file asm/termbits.h which
> contains compatible definitions and structures for ioctl calls.
>
> Signed-off-by: Pali Rohár <pali@kernel.org>
Thanks for the patch. I'll wait to see if someone from glibc reviews
the change.
I'll add some comments about the formatting for now.
Cheers,
Alex
> ---
> man2/ioctl_tty.2 | 17 +++++++++++++++--
> 1 file changed, 15 insertions(+), 2 deletions(-)
>
> diff --git a/man2/ioctl_tty.2 b/man2/ioctl_tty.2
> index c1875530f0b1..91aceddb7828 100644
> --- a/man2/ioctl_tty.2
> +++ b/man2/ioctl_tty.2
> @@ -11,8 +11,8 @@ ioctl_tty \- ioctls for terminals and serial lines
> .SH SYNOPSIS
> .nf
> .B #include <sys/ioctl.h>
> -.BR "#include <termios.h>" " /* Definition of " CLOCAL ", and"
> -.BR " TC*" { FLUSH , ON , OFF "} constants */"
> +.BR "#include <asm/termbits.h>" " /* Definition of " struct " " termios ", " struct " " termios2 ","
A single space between tokens is enough: s/>" "/>" "/
Join related tokens: s/struct " " termios/"struct termios"/
Tokens without spaces don't need quoting: s/","$/,/
> +.BR " " " " BOTHER ", " CLOCAL ", and " TC* { FLUSH , ON , OFF "} constants */"
Please format everything into at most 80 columns, and preferably 78.
Right now I see:
[
SYNOPSIS
#include <sys/ioctl.h>
#include <asm/termbits.h> /* Definition of struct termios,
struct termios2,
BOTHER, CLOCAL, and
TC*{FLUSH,ON,OFF} constants */
int ioctl(int fd, int cmd, ...);
]
Maybe break between the 2 structs, and after that "and".
Also, I'd add an "and" just before the constants to make clear that
"constants" only applies to them.
> .PP
> .BI "int ioctl(int " fd ", int " cmd ", ...);"
> .fi
> @@ -31,6 +31,19 @@ makes for nonportable programs.
> Use the POSIX interface described in
> .BR termios (3)
> whenever possible.
> +.PP
> +Please note that
> +.B struct termios
> +from
> +.B #include <asm/termbits.h>
> +is different and incompatible with
> +.B struct termios
> +from
> +.BR "#include <termios.h>" .
> +These ioctl calls require
> +.B struct termios
> +from
> +.BR "#include <asm/termbits.h>" .
> .SS Get and set terminal attributes
> .TP
> .B TCGETS
>
--
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/
next prev parent reply other threads:[~2021-07-30 12:03 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-30 10:53 [PATCH] ioctl_tty.2: Fix information about header include file Pali Rohár via Libc-alpha
2021-07-30 12:02 ` Alejandro Colomar (man-pages) via Libc-alpha [this message]
2021-07-30 13:05 ` [PATCH v2] " Pali Rohár via Libc-alpha
2021-08-08 8:26 ` Alejandro Colomar (man-pages) via Libc-alpha
2021-08-31 20:28 ` [PATCH v3] " Pali Rohár via Libc-alpha
2021-09-10 17:39 ` Pali Rohár via Libc-alpha
2021-09-10 19:47 ` Alejandro Colomar (man-pages) via Libc-alpha
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
List information: https://www.gnu.org/software/libc/involved.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f521c025-e219-fa72-505b-5bec149446cf@gmail.com \
--to=libc-alpha@sourceware.org \
--cc=alx.manpages@gmail.com \
--cc=g.branden.robinson@gmail.com \
--cc=kabel@kernel.org \
--cc=linux-man@vger.kernel.org \
--cc=mtk.manpages@gmail.com \
--cc=pali@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 read-only IMAP folder(s) and NNTP newsgroup(s).