Re: [PATCH v3] ioctl_tty.2: Add example how to get or set baudrate on the serial port
From: Alejandro Colomar (man-pages) <hidden>
Date: 2021-08-08 21:19:47
From: Alejandro Colomar (man-pages) <hidden>
Date: 2021-08-08 21:19:47
Hi Pali, On 8/8/21 11:05 PM, Pali Rohár wrote:
quoted
When you send v4, please include the above text (or something similar) to the commit message.Hello Alejandro! Sure I will put description into commit message. Moreover this kind of information should be properly documented into ioctl_tty.2 manpage itself. But I really do not know in which part. Into ioctl (and which?)? Or separate paragraph? As it basically describe some field of struct termios and struct termios2, which are undocumented too. Do you have some idea or picture how such thing should be properly documented in man-pages project?
Being documentation for a type, I think the best place for that is system_data_types(7) <https://man7.org/linux/man-pages/man7/system_data_types.7.html>. Do you feel like writing that? See the thread we started the other day: <https://lore.kernel.org/linux-man/5e9e1f1a-1e08-59f5-6579-a02c0738b9a4@gmail.com/T/#u (local)> You can also get some inspiration from other pages that also define types, like stat(2), and sigevent(7). Thanks, Alex -- Alejandro Colomar Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/ http://www.alejandro-colomar.es/