linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: enh <enh@google.com>, linux-man <linux-man@vger.kernel.org>
Subject: Re: 3p page wording
Date: Thu, 14 Sep 2023 01:33:01 +0200	[thread overview]
Message-ID: <dce24a2c-d173-4793-a509-f886c6edd4b4@kernel.org> (raw)
In-Reply-To: <f0fb0139-1544-415b-a4e1-af4ae92b933d@kernel.org>


[-- Attachment #1.1: Type: text/plain, Size: 1164 bytes --]

On 2023-09-13 23:50, Alejandro Colomar wrote:
> Hi enh,
> 
> On 2023-09-13 21:58, enh wrote:
>> is it a requirement that the 3p pages only contain text that's
>> explicitly in POSIX?
> 
> Yes, I guess.
> 
>> the siginfo_t::si_addr description on
>> system_data_types.7 (which is what people see if they `man siginfo_t`)
>> says "Address of faulting instruction", which isn't true for all
>> signals, and caused enough confusion for the ART maintainers that they
>> came to me as Android's libc maintainer for an adjudication. meanwhile
>> the sigaction.2 page says "Memory location which caused fault" which
>> seems much more helpful.
> 
> siginfo_t(3type), aka system_data_types(7), isn't a POSIX page, so
> we can patch it if you want.
> 
> I'd also move the types to their own pages and have system_data_types(7)
> be a link to intro(3) (until we have an intro(3type)).

I've done this.  Please check if you approve these patches:

<https://git.kernel.org/pub/scm/docs/man-pages/man-pages.git/log/?h=contrib>

Cheers,
Alex

-- 
<http://www.alejandro-colomar.es/>
GPG key fingerprint: A9348594CE31283A826FBDD8D57633D441E25BB5


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

  reply	other threads:[~2023-09-13 23:33 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-09-13 19:58 3p page wording enh
2023-09-13 21:50 ` Alejandro Colomar
2023-09-13 23:33   ` Alejandro Colomar [this message]
2023-09-19 21:21     ` enh
2023-09-26  0:08       ` Alejandro Colomar
2023-09-19  4:22 ` Florian Weimer

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=dce24a2c-d173-4793-a509-f886c6edd4b4@kernel.org \
    --to=alx@kernel.org \
    --cc=enh@google.com \
    --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 NNTP newsgroup(s).