From: "Alejandro Colomar (man-pages)" <alx.manpages@gmail.com>
To: "Pali Rohár" <pali@kernel.org>
Cc: Michael Kerrisk <mtk.manpages@gmail.com>, linux-man@vger.kernel.org
Subject: Re: [PATCH] ioctl_tty.2: Document ioctls: TCGETS2, TCSETS2, TCSETSW2, TCSETSF2
Date: Fri, 30 Jul 2021 01:39:11 +0200 [thread overview]
Message-ID: <7d48a1dd-9641-53e9-bb65-868c86f22821@gmail.com> (raw)
In-Reply-To: <20210729173118.pud4xucnt4kncvol@pali>
Hi Pali,
On 7/29/21 7:31 PM, Pali Rohár wrote:
>
>>> +.IR "<asm/termbits.h>" .
Is that the header that the user should include?
I don't know. I typically avoid 'asm/' includes, but maybe in this case
it's the correct one. Shouldn't the user maybe include <linux/termios.h>?
user@sqli:/usr/include$ grep -rn 'struct termios {'
asm-generic/termbits.h:12:struct termios {
user@sqli:/usr/include$ grep -rn '<asm-generic/termbits.h>'
x86_64-linux-gnu/asm/termbits.h:1:#include <asm-generic/termbits.h>
user@sqli:/usr/include$ grep -rn '<asm/termbits.h>'
asm-generic/termios.h:12:#include <asm/termbits.h>
user@sqli:/usr/include$ grep -rn '<asm-generic/termios.h>'
x86_64-linux-gnu/asm/termios.h:1:#include <asm-generic/termios.h>
user@sqli:/usr/include$ grep -rn '<asm/termios.h>'
linux/termios.h:6:#include <asm/termios.h>
user@sqli:/usr/include$ grep -rn '<linux/termios.h>'
user@sqli:/usr/include$
>>> +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.
>
> Few lines below in this file is:
>
> .IR "struct termios\ *" .
> .IP
> .BI "TCGETA struct termio *" argp
> .IP
> .BI "TCSETA const struct termio *" argp
> .IP
> .BI "TCSETAW const struct termio *" argp
> .IP
> .BI "TCSETAF const struct termio *" argp
>
> Therefore I used same style for TCGETS2...
>
> So, how should I format this part to be consistent?
Hmm, sorry, I didn't see those.
So there's a mix in the file.
The more correct form is the one I used, so please use that one (the one
with .TP)
Thanks,
Alex
>
>>> +.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/
--
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-29 23:39 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-25 22:55 [PATCH] ioctl_tty.2: Document ioctls: TCGETS2, TCSETS2, TCSETSW2, TCSETSF2 Pali Rohár
2021-07-29 11:30 ` Alejandro Colomar (man-pages)
2021-07-29 17:31 ` Pali Rohár
2021-07-29 23:39 ` Alejandro Colomar (man-pages) [this message]
2021-07-30 0:09 ` Pali Rohár
2021-07-30 7:04 ` Alejandro Colomar (man-pages)
2021-07-30 10:56 ` Pali Rohár
2021-07-30 0:21 ` Pali Rohár
2021-07-30 7:59 ` Alejandro Colomar (man-pages)
2021-07-30 10:48 ` [PATCH v2] " Pali Rohár
2021-07-30 18:20 ` Alejandro Colomar (man-pages)
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7d48a1dd-9641-53e9-bb65-868c86f22821@gmail.com \
--to=alx.manpages@gmail.com \
--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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.