hanchenye-llvm-project

History

Eric Fiselier 336a1a6811 Rename cxx-benchmark-unittests target and convert to LIT. This patch renames the cxx-benchmark-unittests to check-cxx-benchmarks and converts the target to use LIT in order to make the tests run faster and provide better output. In particular this runs each benchmark in a suite one by one, allowing more parallelism while ensuring output isn't garbage with multiple threads. Additionally, it adds the CMake flag '-DLIBCXX_BENCHMARK_TEST_ARGS=<list>' to specify what options are passed when running the benchmarks. llvm-svn: 346888		2018-11-14 20:38:46 +00:00
..
DesignDocs	[libc++] Make sure we can build libc++ with -fvisibility=hidden	2018-10-25 12:13:43 +00:00
BuildingLibcxx.rst	Rename cxx-benchmark-unittests target and convert to LIT.	2018-11-14 20:38:46 +00:00
CMakeLists.txt	…
Makefile.sphinx	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
README.txt	…
ReleaseNotes.rst	[libc++] Use exclude_from_explicit_instantiation instead of always_inline	2018-10-29 17:30:04 +00:00
TestingLibcxx.rst	…
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.