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

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

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/