This is the mail archive of the libc-alpha@sourceware.org mailing list for the glibc project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [MTASCsft PATCH 38/38] MT-, AS- and AC-Safety docs: sanity check


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


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]