Re: [PATCH] Create nptl manual node and document thread_locallimitation

[Siddhesh Poyarekar <siddhesh at redhat dot com>]

On Wed, Feb 20, 2013 at 11:03:48AM -0500, Carlos O'Donell wrote:
> Please include empty entries for:
> pthread_key_delete
> pthread_getspecific
> pthread_setspecific
> 
> They should say something like "Not currently documented."
> 
> This completes the section on thread-specific data.
> 

I wrote up one-line descriptions for them instead, so here's the
updated patch.

Siddhesh


diff --git a/manual/Makefile b/manual/Makefile
index c1a304c..10314a9 100644
--- a/manual/Makefile
+++ b/manual/Makefile
@@ -42,7 +42,7 @@ chapters = $(addsuffix .texi, \
 		       message search pattern io stdio llio filesys	\
 		       pipe socket terminal syslog math arith time	\
 		       resource setjmp signal startup process job nss	\
-		       users sysinfo conf crypt debug)
+		       users sysinfo conf crypt debug nptl)
 add-chapters = $(wildcard $(foreach d, $(add-ons), ../$d/$d.texi))
 appendices = lang.texi header.texi install.texi maint.texi platform.texi \
 	     contrib.texi
diff --git a/manual/debug.texi b/manual/debug.texi
index b2bcb31..1db9c18 100644
--- a/manual/debug.texi
+++ b/manual/debug.texi
@@ -1,5 +1,5 @@
 @node Debugging Support
-@c @node Debugging Support, , Cryptographic Functions, Top
+@c @node Debugging Support, POSIX Threads, Cryptographic Functions, Top
 @c %MENU% Functions to help debugging applications
 @chapter Debugging support
 
diff --git a/manual/nptl.texi b/manual/nptl.texi
new file mode 100644
index 0000000..c727870
--- /dev/null
+++ b/manual/nptl.texi
@@ -0,0 +1,46 @@
+@node POSIX Threads
+@c @node POSIX Threads, , Cryptographic Functions, Top
+@chapter POSIX Threads
+@c %MENU% POSIX Threads
+@cindex pthreads
+
+This chapter describes the @glibcadj{} POSIX Thread implementation.
+
+@menu
+* Thread-specific Data::          Support for creating and
+				  managing thread-specific data
+@end menu
+
+@node Thread-specific Data
+@section Thread-specific Data
+
+The @glibcadj{} implements functions to allow users to create and manage
+data specific to a thread.  Such data may be destroyed at thread exit,
+if a destructor is provided.  The following functions are defined:
+
+@table @code
+
+@item int pthread_key_create (pthread_key_t *@var{key}, void (*@var{destructor})(void*))
+Create a thread-specific data object for the calling thread, referenced by the
+key @var{key}.  On exit of the calling thread, @var{destructor} is called with
+@var{key} as the argument.
+
+Objects declared with the C++11 @code{thread_local} keyword are destroyed
+before thread-specific data, so they should not be used in pthread
+thread-specific data destructors or even as members of the thread-specific
+data, since the latter is always passed as an argument to the destructor
+function.
+
+@item int pthread_key_delete (pthread_key_t @var{key})
+Destroy the thread-specific data referenced by @var{key} in the calling
+thread.  The destructor for the thread-specific data is not called during
+destruction, nor is it called during thread exit.
+
+@item void *pthread_getspecific (pthread_key_t @var{key})
+Return the thread-specific data referenced by @var{key} in the calling thread.
+
+@item int pthread_setspecific (pthread_key_t @var{key}, const void *@var{value})
+Set @var{value} as the thread-specific data to be referred by @var{key} in the
+calling thread.
+
+@end table