From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: Alejandro Colomar <colomar.6.4.3@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org,
libc-alpha@sourceware.org
Subject: Re: [PATCH v2 8/9] system_data_types.7: Document siginfo_t
Date: Sun, 20 Sep 2020 22:19:45 +0200 [thread overview]
Message-ID: <b4541b7f-7e03-f69a-d3f5-b746066ff1ab@gmail.com> (raw)
In-Reply-To: <20200920180551.63608-1-colomar.6.4.3@gmail.com>
Hello Alex,
On 9/20/20 8:05 PM, Alejandro Colomar wrote:
> Note: There are a few members off this structure that are
> not required by POSIX (XSI extensions, and such).
>
> I simply chose to not document them at all.
>
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
> ---
>
> Hello Michael,
>
> Clearly I needed the weekend!
> Here's the patch as it should have been.
Thanks! Patch applied. Some notes below.
> man7/system_data_types.7 | 39 ++++++++++++++++++++++++++++++++++++---
> 1 file changed, 36 insertions(+), 3 deletions(-)
>
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index a7955f331..080f0057f 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -213,6 +213,39 @@ See also:
> See also the
> .I aiocb
> structure in this page.
> +.\"------------------------------------- siginfo_t --------------------/
> +.TP
> +.I siginfo_t
> +.IP
> +Include:
> +.IR <signal.h> ;
> +or
> +.IR <sys/wait.h> .
> +.IP
> +.EX
> +typedef struct {
> + int si_signo; /* Signal number */
> + int si_code; /* Signal code */
> +
> + pid_t si_pid; /* Sending process ID */
> + uid_t si_uid; /* Real user ID of sending process */
> + void *si_addr; /* Address of faulting instruction */
> + int si_status; /* Exit value or signal */
> +
> + union sigval si_value; /* Signal value */
> +} siginfo_t;
Some minor white space issues in the above structure (blank lines,
misaligned comments); I fixed them.
> +.EE
> +.\".IP
> +.\" FIXME: Add a description?
Generally, I think we always should have a description, even if
very short. I added one, mainly in the form of a reference to
sigaction(2).
> +.IP
> +Conforming to: POSIX.1-2001 and later.
> +.IP
> +See also:
> +.BR pidfd_send_signal (2),
> +.BR rt_sigqueueinfo (2),
> +.BR sigaction (2),
> +.BR sigwaitinfo (2),
> +.BR psiginfo (3)
That list is "just right"; thanks.
> .\"------------------------------------- sigval -----------------------/
> .TP
> .I sigval
> @@ -239,9 +272,9 @@ See also:
> See also the
> .I sigevent
> structure
> -.\"and the
> -.\".I siginfo_t FIXME
> -.\"type
> +and the
> +.I siginfo_t
> +type
> in this page.
> .\"------------------------------------- size_t -----------------------/
> .TP
Thanks,
Michael
--
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/
next prev parent reply other threads:[~2020-09-20 20:19 UTC|newest]
Thread overview: 29+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-09-18 17:04 [PATCH 0/9] Document aiocb, sigevent, siginfo_t Alejandro Colomar
2020-09-18 17:04 ` [PATCH 1/9] system_data_types.7: ffix Alejandro Colomar
2020-09-18 20:49 ` Michael Kerrisk (man-pages)
2020-09-18 17:04 ` [PATCH 2/9] system_data_types.7: srcfix: Add FIXME note: Add descriptions Alejandro Colomar
2020-09-18 20:50 ` Michael Kerrisk (man-pages)
2020-09-18 21:03 ` Michael Kerrisk (man-pages)
2020-09-18 21:35 ` Alejandro Colomar
2020-09-18 17:04 ` [PATCH 3/9] system_data_types.7: Document sigevent Alejandro Colomar
2020-09-18 21:09 ` Michael Kerrisk (man-pages)
2020-09-18 21:36 ` Alejandro Colomar
2020-09-18 17:04 ` [PATCH 4/9] sigevent.3: New link to new documented type in system_data_types(7) Alejandro Colomar
2020-09-18 21:10 ` Michael Kerrisk (man-pages)
2020-09-18 21:39 ` Alejandro Colomar
2020-09-18 21:43 ` Michael Kerrisk (man-pages)
2020-09-18 21:57 ` Alejandro Colomar
2020-09-19 8:11 ` Michael Kerrisk (man-pages)
2020-09-18 17:04 ` [PATCH 5/9] system_data_types.7: srcfix: cosmetic: Visually sparate types Alejandro Colomar
2020-09-18 21:14 ` Michael Kerrisk (man-pages)
2020-09-18 17:04 ` [PATCH 6/9] system_data_types.7: Document aiocb Alejandro Colomar
2020-09-18 17:04 ` [PATCH 7/9] aiocb.3: New link to new documented type in system_data_types(7) Alejandro Colomar
2020-09-18 21:28 ` Michael Kerrisk (man-pages)
2020-09-18 17:04 ` [PATCH 8/9] system_data_types.7: Document siginfo_t Alejandro Colomar
2020-09-18 21:42 ` Michael Kerrisk (man-pages)
2020-09-18 21:45 ` Alejandro Colomar
2020-09-20 18:05 ` [PATCH v2 " Alejandro Colomar
2020-09-20 20:19 ` Michael Kerrisk (man-pages) [this message]
2020-09-20 18:05 ` [PATCH v2 9/9] siginfo_t.3: New link to new documented type in system_data_types(7) Alejandro Colomar
2020-09-20 20:19 ` Michael Kerrisk (man-pages)
2020-09-18 17:04 ` [PATCH " Alejandro Colomar
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=b4541b7f-7e03-f69a-d3f5-b746066ff1ab@gmail.com \
--to=mtk.manpages@gmail.com \
--cc=colomar.6.4.3@gmail.com \
--cc=libc-alpha@sourceware.org \
--cc=linux-man@vger.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).