From: "Alejandro Colomar \(man-pages\) via Libc-alpha" <libc-alpha@sourceware.org>
To: "Pali Rohár" <pali@kernel.org>
Cc: "Marek Behún" <kabel@kernel.org>,
"G. Branden Robinson" <g.branden.robinson@gmail.com>,
libc-alpha@sourceware.org,
"Michael Kerrisk" <mtk.manpages@gmail.com>,
linux-man@vger.kernel.org
Subject: Re: [PATCH v3] ioctl_tty.2: Add example how to get or set baudrate on the serial port
Date: Sun, 8 Aug 2021 23:19:42 +0200 [thread overview]
Message-ID: <27a03c58-33d5-0c63-5228-3320db1f42ad@gmail.com> (raw)
In-Reply-To: <20210808210530.ykqrihpfmdabbdl2@pali>
Hi Pali,
On 8/8/21 11:05 PM, Pali Rohár wrote:
>> 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>
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/
next prev parent reply other threads:[~2021-08-08 21:20 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-07-30 9:53 [PATCH] ioctl_tty.2: Add example how to get or set baudrate on the serial port Pali Rohár via Libc-alpha
2021-07-30 11:47 ` Alejandro Colomar (man-pages) via Libc-alpha
2021-07-30 12:05 ` Pali Rohár via Libc-alpha
2021-07-30 12:21 ` Alejandro Colomar (man-pages) via Libc-alpha
2021-07-30 13:02 ` [PATCH v2] " Pali Rohár via Libc-alpha
2021-08-01 13:51 ` [PATCH v3] " Pali Rohár via Libc-alpha
2021-08-04 22:08 ` Pali Rohár via Libc-alpha
2021-08-05 5:52 ` Greg Kroah-Hartman via Libc-alpha
2021-08-05 8:22 ` Pali Rohár via Libc-alpha
2021-08-05 8:30 ` Greg Kroah-Hartman via Libc-alpha
2021-08-05 8:44 ` Pali Rohár via Libc-alpha
2021-08-05 8:50 ` Greg Kroah-Hartman via Libc-alpha
2021-08-05 9:51 ` Pali Rohár via Libc-alpha
2021-08-05 15:28 ` Alejandro Colomar (man-pages) via Libc-alpha
2021-08-05 16:14 ` Greg Kroah-Hartman via Libc-alpha
2021-08-05 16:45 ` Licensing example programs in man-pages (was [PATCH v3] ioctl_tty.2: Add example how to get or set baudrate on the serial port) Alejandro Colomar (man-pages) via Libc-alpha
2021-08-05 17:54 ` Greg Kroah-Hartman via Libc-alpha
2021-08-06 7:22 ` Alejandro Colomar (man-pages) via Libc-alpha
2021-08-06 8:32 ` Pali Rohár via Libc-alpha
2021-08-08 8:35 ` [PATCH v3] ioctl_tty.2: Add example how to get or set baudrate on the serial port Alejandro Colomar (man-pages) via Libc-alpha
2021-08-08 21:05 ` Pali Rohár via Libc-alpha
2021-08-08 21:19 ` Alejandro Colomar (man-pages) via Libc-alpha [this message]
2021-08-10 19:49 ` [PATCH v4] " Pali Rohár via Libc-alpha
2021-08-10 20:11 ` Pali Rohár via Libc-alpha
2021-08-31 20:34 ` Pali Rohár via Libc-alpha
2021-09-10 13:37 ` Alejandro Colomar (man-pages) via Libc-alpha
2021-09-10 13:39 ` Pali Rohár via Libc-alpha
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
List information: https://www.gnu.org/software/libc/involved.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=27a03c58-33d5-0c63-5228-3320db1f42ad@gmail.com \
--to=libc-alpha@sourceware.org \
--cc=alx.manpages@gmail.com \
--cc=g.branden.robinson@gmail.com \
--cc=kabel@kernel.org \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).