llvm-project/libcxx/docs
Louis Dionne 0c66af970c [libc++] Allow specifying custom Lit config files
Before this patch, the libc++ test suite first loads lit.site.cfg
(generated by CMake), and then lit.cfg. It's also possible to load
lit.cfg before lit.site.cfg and to point to a custom lit.site.cfg
file using '--param=libcxx_site_config'. However, in that case, lit.cfg
still relies on the site configuration filling up the 'config' object
like the default lit.site.cfg file does, which isn't flexible enough.

This commit simplifies the setup by having just a single Lit site config
file per CMake configuration, and always loading exactly that config file.
However, the config file to use can be selected when setting up CMake via
the LIBCXX_TEST_CONFIG setting. Furthermore, the site configs are entirely
standalone, which means that a new site config can be added that doesn't
need to conform what's expected by config.py.

Differential Revision: https://reviews.llvm.org/D81846
2020-06-18 10:06:04 -04:00
..
DesignDocs [libc++] Do not rely on use_system_cxx_lib to specify the path of the library to run against 2020-05-15 13:01:37 -04:00
BuildingLibcxx.rst [libc++] Fix the LIBCXX_HAS_MERGED_TYPEINFO_NAMES_DEFAULT setting 2020-05-29 06:14:30 -04:00
CMakeLists.txt docs: Fix Sphinx detection with out-of-tree builds 2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst [libc++] Complete overhaul of constexpr support in std::array 2020-05-28 12:31:06 -04:00
Makefile.sphinx Add design docs for upcoming file_time_type change. 2018-07-25 02:53:53 +00:00
README.txt
ReleaseNotes.rst Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
TestingLibcxx.rst [libc++] Allow specifying custom Lit config files 2020-06-18 10:06:04 -04:00
UsingLibcxx.rst Doc: Links should use https 2020-03-22 22:49:33 +01:00
conf.py Bump the trunk major version to 11 2020-01-15 13:38:01 +01:00
index.rst [libc++] Remove workarounds for the lack of clock_gettime on older macOS platforms 2020-06-09 12:57:03 -04: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.