2021-08-02 12:42:32

by Alejandro Colomar

Subject: Document the types "struct termios" and "struct termios2"

Hi,

From a few patches of Pali and their subsequent discussions, it was
clear that those types need to be documented (the most appropriate place
being system_data_types(7), with link pages termios-struct(3) and
termios2-struct(3)).

The most important part (the one we had problems with) being which
headers should be included for each type (and for each version of the
type (kernel/glibc)). That includes the recommended header, and other
headers that _shall_ also provide the type.

Is there someone that knows those types enough to write such
documentation and wants to do it? :)

Thanks,

Alex

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

2021-08-02 12:54:57

by Pali Rohár

Subject: Re: Document the types "struct termios" and "struct termios2"

+ linux-serial

On Monday 02 August 2021 14:38:43 Alejandro Colomar (man-pages) wrote:
> Hi,
>
> From a few patches of Pali and their subsequent discussions,

For others, link to patch with code example:
https://lore.kernel.org/linux-man/[email protected]/

And links to other discussions:
https://lore.kernel.org/linux-man/[email protected]/t/#u
https://lore.kernel.org/linux-man/[email protected]/t/#u
https://lore.kernel.org/linux-man/[email protected]/t/#u

> it was clear
> that those types need to be documented (the most appropriate place being
> system_data_types(7), with link pages termios-struct(3) and
> termios2-struct(3)).
>
> The most important part (the one we had problems with) being which headers
> should be included for each type (and for each version of the type
> (kernel/glibc)). That includes the recommended header, and other headers
> that _shall_ also provide the type.
>
> Is there someone that knows those types enough to write such documentation
> and wants to do it? :)
>
> Thanks,
>
> Alex
>
> --
> Alejandro Colomar
> Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
> http://www.alejandro-colomar.es/

2021-08-02 13:08:28

by Alejandro Colomar

Subject: Re: Document the types "struct termios" and "struct termios2"

+= linux-man@

:)

On 8/2/21 2:50 PM, Pali Rohár wrote:
> + linux-serial
>
> On Monday 02 August 2021 14:38:43 Alejandro Colomar (man-pages) wrote:
>> Hi,
>>
>> From a few patches of Pali and their subsequent discussions,
>
> For others, link to patch with code example:
> https://lore.kernel.org/linux-man/[email protected]/
>
> And links to other discussions:
> https://lore.kernel.org/linux-man/[email protected]/t/#u
> https://lore.kernel.org/linux-man/[email protected]/t/#u
> https://lore.kernel.org/linux-man/[email protected]/t/#u
>
>> it was clear
>> that those types need to be documented (the most appropriate place being
>> system_data_types(7), with link pages termios-struct(3) and
>> termios2-struct(3)).
>>
>> The most important part (the one we had problems with) being which headers
>> should be included for each type (and for each version of the type
>> (kernel/glibc)). That includes the recommended header, and other headers
>> that _shall_ also provide the type.
>>
>> Is there someone that knows those types enough to write such documentation
>> and wants to do it? :)
>>
>> Thanks,
>>
>> Alex
>>
>> --
>> 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/