llvm-project/libcxx/docs
Shoaib Meenai 3888eb66b0 [libc++] Clarify _LIBCPP_NEW_DELETE_VIS for Windows
Replace a stale reference to cxx_EXPORTS with _LIBCPP_BUILDING_LIBRARY,
and clarify why the operator new and delete family of functions are
marked dllexport when building but *not* dllimport when including the
header externally.

The new code is identical to the intent of the old code (and would be
functionally equivalent were cxx_EXPORTS still defined when building
libc++). The overall behavior is not ideal, since Microsoft's operator
new and delete functions will get called instead of libc++'s, but I
think consistently calling msvcrt's functions is better than either
calling msvcrt's or libc++'s functions depending on header inclusion.

Differential Revision: https://reviews.llvm.org/D25042

llvm-svn: 282644
2016-09-28 22:28:51 +00:00
..
DesignDocs [libc++] Clarify _LIBCPP_NEW_DELETE_VIS for Windows 2016-09-28 22:28:51 +00:00
BuildingLibcxx.rst Attempt to fix Sphinx build 2016-09-16 03:47:53 +00:00
CMakeLists.txt
Makefile.sphinx Attempt to fix Sphinx build 2016-09-16 03:47:53 +00:00
README.txt Remove test commit. 2015-09-05 05:38:50 +00:00
TestingLibcxx.rst Attempt to fix Sphinx build 2016-09-16 03:47:53 +00:00
UsingLibcxx.rst Fix errors in documentation 2016-05-06 04:49:30 +00:00
conf.py Update version numbers in docs 2016-05-03 22:50:33 +00:00
index.rst [libc++] Fix and document visibility attributes for Clang, GCC and Windows. 2016-09-15 22:27:07 +00:00

README.txt

libc++ Documentation
====================

The libc++ documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libc++ with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBCXX_INCLUDE_DOCS=ON

After configuring libc++ with these options the make rule `docs-libcxx-html`
should be available.