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

From: Pali Rohár
Date: Mon Aug 02 2021 - 08:50:42 EST


+ 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/20210801135146.14849-1-pali@xxxxxxxxxx/

And links to other discussions:
https://lore.kernel.org/linux-man/20210725225506.7404-1-pali@xxxxxxxxxx/t/#u
https://lore.kernel.org/linux-man/20210730105353.10424-1-pali@xxxxxxxxxx/t/#u
https://lore.kernel.org/linux-man/20210730153044.23673-1-pali@xxxxxxxxxx/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/