llvm-project/libcxx/docs
Louis Dionne f14927e98e [libcxx] Always enable availability in the lit test suite.
Summary:
Running the tests without availability enabled doesn't really make sense:
availability annotations allow catching errors at compile-time instead
of link-time. Running the tests without availability enabled allows
confirming that a test breaks at link-time under some configuration,
but it is more useful to instead check that it should fail at compile-time.

Always enabling availability in the lit test suite will greatly simplify
XFAILs and troubleshooting of failing tests, which is currently a giant
pain because we have these two levels of possible failure: link-time and
compile-time.

Reviewers: EricWF, mclow.lists

Subscribers: christof, jkorous, dexonsmith, libcxx-commits

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

llvm-svn: 348296
2018-12-04 19:31:08 +00:00
..
DesignDocs [libcxx] Always enable availability in the lit test suite. 2018-12-04 19:31:08 +00:00
BuildingLibcxx.rst [libcxx] Mention restriction on inline namespaces in LIBCXX_ABI_NAMESPACE docs 2018-11-16 14:57:47 +00:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt Remove test commit. 2015-09-05 05:38:50 +00:00
ReleaseNotes.rst [libcxx] Remove bad_array_length 2018-11-29 19:44:57 +00:00
TestingLibcxx.rst Teach test suite about C++2a dialect flag. 2017-11-07 20:26:23 +00:00
UsingLibcxx.rst [libc++] Add deprecated attributes to many deprecated components 2018-09-23 18:35:00 +00:00
conf.py fix some typos in the doc 2018-09-20 08:05:01 +00:00
index.rst Correct docs to reference the new libc++ lists. 2018-09-22 19:49:29 +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.