This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
[patch] Document that std::thread::native_handle() and similar are not portable or stable
- From: Jonathan Wakely <jwakely at redhat dot com>
- To: libstdc++ at gcc dot gnu dot org, gcc-patches at gcc dot gnu dot org
- Date: Fri, 17 Jul 2015 17:09:35 +0100
- Subject: [patch] Document that std::thread::native_handle() and similar are not portable or stable
- Authentication-results: sourceware.org; auth=none
This just adds a caveat to the docs that the semantics of
native_handles should not be relied on.
Committed to trunk.
commit 46e6c523b7d2d38cc3b31b77a19639f4b2634671
Author: Jonathan Wakely <jwakely@redhat.com>
Date: Fri Jul 17 17:07:30 2015 +0100
* doc/xml/manual/status_cxx2011.xml: Add caveats for native_handle.
* doc/html/manual/status.html: Regenerate.
diff --git a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
index 2b99b9d..cf99956 100644
--- a/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
+++ b/libstdc++-v3/doc/xml/manual/status_cxx2011.xml
@@ -2670,7 +2670,10 @@ particular release.
<emphasis>30.2.3 [thread.req.native]/1</emphasis>
<classname>native_handle_type</classname> and
<methodname>native_handle</methodname> are provided. The handle types
- are defined in terms of the Gthreads abstraction layer.
+ are defined in terms of the Gthreads abstraction layer, although this
+ is subject to change at any time. Any use of
+ <classname>native_handle</classname> is inherently non-portable and
+ not guaranteed to work between major releases of GCC.
<itemizedlist>
<listitem><para><classname>thread</classname>: The native handle type is
a typedef for <code>__gthread_t</code> i.e. <code>pthread_t</code>