This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: [PATCH 3/3] manual: Add new header and standards annotations.
- From: Joseph Myers <joseph at codesourcery dot com>
- To: Rical Jasan <ricaljasan at pacific dot net>
- Cc: Florian Weimer <fweimer at redhat dot com>, <libc-alpha at sourceware dot org>, Michael Kerrisk <mtk dot manpages at gmail dot com>, Carlos O'Donell <carlos at redhat dot com>
- Date: Fri, 2 Dec 2016 13:55:48 +0000
- Subject: Re: [PATCH 3/3] manual: Add new header and standards annotations.
- Authentication-results: sourceware.org; auth=none
- References: <20161123063807.14845-1-ricaljasan@pacific.net> <20161123063807.14845-4-ricaljasan@pacific.net> <alpine.DEB.2.20.1611231733010.31292@digraph.polyomino.org.uk> <64fa1a5a-4af3-5e3f-b192-e79203c3e328@pacific.net> <alpine.DEB.2.20.1611241318060.2194@digraph.polyomino.org.uk> <f4f45b8f-7d4d-b846-356d-3cad4dd1c104@pacific.net> <alpine.DEB.2.20.1611251425271.28633@digraph.polyomino.org.uk> <951c0013-8227-46c3-6d05-678bca61f2ce@pacific.net> <c250e0e5-d019-f7bb-fa15-81f36ecd0424@redhat.com> <alpine.DEB.2.20.1611301238090.3647@digraph.polyomino.org.uk> <f6854084-4767-d396-9826-56a128c73530@pacific.net>
On Fri, 2 Dec 2016, Rical Jasan wrote:
> Safety: MT-Safe | AS-Unsafe heap | AC-Unsafe mem fd | See Section
> 1.2.2.1 [POSIX Safety Concepts], page 2.
> Standards: POSIX.1 (unistd.h), See Section 1.3.4 [Feature Test Macros],
> page 15.
> Added in: 2.0
I'm envisaging "Safety" and "Standards" being plain links (in the HTML and
PDF manuals) to the relevant manual sections, so you don't have the " |
See Section 1.2.2.1 [POSIX Safety Concepts], page 2." and ", See Section
1.3.4 [Feature Test Macros], page 15." text at all. That makes things
much shorter. (I don't know if you can readily make such plain links from
Texinfo at present, but I think it looks a lot better that way when you
have such annotations appearing for every interface in the manual.)
--
Joseph S. Myers
joseph@codesourcery.com