Re: [PATCH 2/2] Document LIBC_PTHREAD_DEFAULT_STACKSIZE_NP

[Carlos O'Donell <carlos at systemhalted dot org>]

On 01/16/2013 06:52 PM, Roland McGrath wrote:
> The name "NPTL" is an implementation artifact.  The manual describes the
> interface for users of the library, not the implementation.  The right name
> for a chapter about the pthreads interface is "pthreads" or "threads".
> 
> A chapter that doesn't actually document the interface and is fully of TODO
> markers should not actually be included in the manual.  I'm fine with
> writing down fragments of documentation that don't yet have a sensible
> place to live in the manual.  But we won't include them in the manual until
> they are part of a sensical whole.

I agree that the TODO entries should be removed.

However, just to be clear, it is my opinion that we should:

(a) create a pthread chapter

(b) start accepting patches to it and make them immediately visible.

I think we need to do this one piece at a time, one step at a time,
growing what we document bit-by-bit.

It seems the only sensible way given our limited resources.

Siddhesh's patch to add pthread functions can and should:

(a) create a pthread chapter

(b) document the interfaces he adds.

Does that make sense?

Cheers,
Carlos.