This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: [MTASCsft PATCH 38/38] MT-, AS- and AC-Safety docs: sanity check
- From: "Joseph S. Myers" <joseph at codesourcery dot com>
- To: Carlos O'Donell <carlos at redhat dot com>
- Cc: Alexandre Oliva <aoliva at redhat dot com>, <codonell at redhat dot com>, <libc-alpha at sourceware dot org>
- Date: Mon, 3 Feb 2014 18:19:58 +0000
- Subject: Re: [MTASCsft PATCH 38/38] MT-, AS- and AC-Safety docs: sanity check
- Authentication-results: sourceware.org; auth=none
- References: <ortxelb5zd dot fsf at livre dot home> <or4n4uoncj dot fsf at livre dot home> <oreh3sena6 dot fsf_-_ at livre dot home> <52EC71B2 dot 7000801 at redhat dot com> <orppn7jqfo dot fsf at livre dot home> <52EFA42F dot 3030402 at redhat dot com>
On Mon, 3 Feb 2014, Carlos O'Donell wrote:
> I would also really like belt and suspender checks to ensure that
> new functions are documented in the manual would also be awesome...
> *wink* *wink* *nudge* *nudge*. We already know the list of functions
> from the abi list, then we just need to check defs in the manual
> texinfos.
Properly documentation is about APIs not ABIs, though the exported
functions outside the reserved namespace are a reasonable start (and
scripts/documented.sh - rather out of date - appears to work based on
exported functions).
(For testing, as previously discussed - see link from wiki todo list to
list of untested functions - we do want testcases to cover all the
non-compat ABIs, as well as all the APIs.)
For both documentation and testing we really need to attract people to
adding tests / documentation of functions that aren't covered, bit by bit,
so gradually the large backlog goes down.
--
Joseph S. Myers
joseph@codesourcery.com