llvm-project

History

Louis Dionne 86dd28a547 [libc++] Use [[nodiscard]] for lock_guard, as an extension Summary: D64914 added support for applying [[nodiscard]] to constructors. This commit uses that capability to flag incorrect uses of std::lock_guard where one forgets to actually create a variable for the lock_guard. rdar://45790820 Reviewers: mclow.lists, EricWF Subscribers: christof, jkorous, dexonsmith, libcxx-commits, Quuxplusone, lebedev.ri Tags: #libc Differential Revision: https://reviews.llvm.org/D65900 llvm-svn: 368664		2019-08-13 11:12:28 +00:00
..
DesignDocs	Add documentation and tests for Clangs C++11 extensions in C++03.	2019-06-11 22:53:49 +00:00
BuildingLibcxx.rst	docs: add documentation for `LIBCXX_INCLUDE_TESTS`	2019-07-04 19:08:16 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
FeatureTestMacroTable.rst	P0722R3: Implement library support for destroying delete	2019-05-23 23:46:44 +00: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 version to 10.0.0svn	2019-07-18 11:51:05 +00:00
TestingLibcxx.rst	[CMake] Support compiler-rt builtins library in tests	2019-02-05 19:50:47 +00:00
UsingLibcxx.rst	[libc++] Use [[nodiscard]] for lock_guard, as an extension	2019-08-13 11:12:28 +00:00
conf.py	Bump the trunk version to 10.0.0svn	2019-07-18 11:51:05 +00:00
index.rst	Make GCC in C++03 Unsupported	2019-06-13 00:37:25 +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.