darlinghq/darling-libcxx
1
0
Fork 0
mirror of https://github.com/darlinghq/darling-libcxx.git synced 2024-12-03 17:41:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
ebaf7dab14
darling-libcxx/docs
History
Eric Fiselier ebaf7dab14 Add _LIBCPP_DIAGNOSE_WARNING and _LIBCPP_DIAGNOSE_ERROR macros. 
Clang recently added a `diagnose_if(cond, msg, type)` attribute
which can be used to generate diagnostics when `cond` is a constant
expression that evaluates to true. Otherwise no attribute has no
effect.

This patch adds _LIBCPP_DIAGNOSE_ERROR/WARNING macros which
use this new attribute. Additionally this patch implements
a diagnostic message when a non-const-callable comparator is
given to a container.

Note: For now the warning version of the diagnostic is useless
within libc++ since warning diagnostics are suppressed by the
system header pragma. I'm going to work on fixing this.

git-svn-id: https://llvm.org/svn/llvm-project/libcxx/trunk@291961 91177308-0d34-0410-b5e6-96231b3b80d8
2017-01-13 22:02:08 +00:00
..
DesignDocs [libc++] Correct macro name in documenation 2017-01-07 02:45:35 +00:00
BuildingLibcxx.rst Add start of filesystem benchmarks 2016-10-30 22:53:00 +00:00
CMakeLists.txt [libcxx] Add new Sphinx documentation 2015-08-22 19:40:49 +00:00
conf.py Update version to 5.0 2017-01-13 18:29:56 +00:00
index.rst [libc++] Cleanup and document <__threading_support> 2017-01-06 20:05:40 +00:00
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 Update TestingLibcxx doc to reflect the use_system_cxx_lib flag. Patch from Michael Park 2016-12-23 19:09:14 +00:00
UsingLibcxx.rst Add _LIBCPP_DIAGNOSE_WARNING and _LIBCPP_DIAGNOSE_ERROR macros. 2017-01-13 22:02:08 +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.