[PATCH] D28610: [libcxx] Improve design documentation for the external-thread-library configuration

Phabricator via Phabricator via cfe-commits cfe-commits at lists.llvm.org
Mon Jan 16 04:55:15 PST 2017

This revision was automatically updated to reflect the committed changes.
Closed by commit rL292108: [libcxx] Improve design documentation for the external-thread-library (authored by asiri).

Changed prior to commit:




Index: libcxx/trunk/docs/DesignDocs/ThreadingSupportAPI.rst
--- libcxx/trunk/docs/DesignDocs/ThreadingSupportAPI.rst
+++ libcxx/trunk/docs/DesignDocs/ThreadingSupportAPI.rst
@@ -33,13 +33,22 @@
 External Threading Library
-Normally ``<__threading_support>`` provides inline definitions to each internal
-threading API function it declares. However libc++ also supports using an
-external library to provide the definitions.
-When ``_LIBCPP_HAS_THREAD_LIBRARY_EXTERNAL`` libc++ does not provide inline
-definitions for the internal API, instead assuming the definitions will be
-provided by an external library.
+libc++ can be compiled with its internal threading API delegating to an external
+library. Such a configuration is useful for library vendors who wish to
+distribute a thread-agnostic libc++ library, where the users of the library are
+expected to provide the implementation of the libc++ internal threading API.
+On a production setting, this would be achieved through a custom
+``<__external_threading>`` header, which declares the libc++ internal threading
+API but leaves out the implementation.
+The ``-DLIBCXX_BUILD_EXTERNAL_THREAD_LIBRARY`` option allows building libc++ in
+such a configuration while allowing it to be tested on a platform that supports
+any of the threading systems (e.g. pthread) supported in ``__threading_support``
+header. Therefore, the main purpose of this option is to allow testing of this
+particular configuration of the library without being tied to a vendor-specific
+threading system. This option is only meant to be used by libc++ library
 Threading Configuration Macros

-------------- next part --------------
A non-text attachment was scrubbed...
Name: D28610.84548.patch
Type: text/x-patch
Size: 1774 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/cfe-commits/attachments/20170116/99df30f6/attachment.bin>

More information about the cfe-commits mailing list