[8/9] system_data_types.7: Document siginfo_t

  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>
---
 man7/system_data_types.7 | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)
  

Hi Alex,

See below.


On 9/18/20 7:04 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>
> ---
>  man7/system_data_types.7 | 35 ++++++++++++++++++++++++++++++++---
>  1 file changed, 32 insertions(+), 3 deletions(-)
> 
> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
> index f7d25bec9..b705ed5ae 100644
> --- a/man7/system_data_types.7
> +++ b/man7/system_data_types.7
> @@ -213,6 +213,35 @@ 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;
> +.EE
> +.\".IP
> +.\" FIXME: Add a description?
> +.IP
> +Conforming to: POSIX.1-2001 and later.
> +.IP
> +See also:
> +.BR regexec (3)

Long day for both of us, and I think the line above shows that :-).

I'm not applying this patch (or the corresponding link patch)... 

For "description" (in the next iteration of this patch),
I think you should defer to sigaction(2).

Thanks

Michael

>  .\"------------------------------------- sigval -----------------------/
>  .TP
>  .I sigval
> @@ -239,9 +268,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
>
  

Hi Michael,

On 2020-09-18 23:42, Michael Kerrisk (man-pages) wrote:
> Hi Alex,
> 
> See below.
> 
> 
> On 9/18/20 7:04 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>
>> ---
>>   man7/system_data_types.7 | 35 ++++++++++++++++++++++++++++++++---
>>   1 file changed, 32 insertions(+), 3 deletions(-)
>>
>> diff --git a/man7/system_data_types.7 b/man7/system_data_types.7
>> index f7d25bec9..b705ed5ae 100644
>> --- a/man7/system_data_types.7
>> +++ b/man7/system_data_types.7
>> @@ -213,6 +213,35 @@ 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;
>> +.EE
>> +.\".IP
>> +.\" FIXME: Add a description?
>> +.IP
>> +Conforming to: POSIX.1-2001 and later.
>> +.IP
>> +See also:
>> +.BR regexec (3)
> 
> Long day for both of us, and I think the line above shows that :-).

Ooooooooops! :p

I'll rebase tomorrow, and then I'll start fixing things...

Too many patches for today!

> 
> I'm not applying this patch (or the corresponding link patch)...
> 
> For "description" (in the next iteration of this patch),
> I think you should defer to sigaction(2).

Ok, thanks!

Cheers,

Alex

> 
> Thanks
> 
> Michael
> 
>>   .\"------------------------------------- sigval -----------------------/
>>   .TP
>>   .I sigval
>> @@ -239,9 +268,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
>>
> 
>