llvm-project/libcxx/docs
Eric Fiselier bd688258ba Fix PR27374 - Remove the implicit reduced-arity-extension in tuple.
This patch removes libc++'s tuple extension which allowed it to be
constructed from fewer initializers than elements; with the remaining
elements being default constructed. However the implicit version of
this extension breaks conforming code. For example:

    int fun(std::string);
    int fun(std::tuple<std::string, int>);
    int x = fun("hello"); // ambigious

Because existing code may already depend on this extension it can be re-enabled
by defining _LIBCPP_ENABLE_TUPLE_IMPLICIT_REDUCED_ARITY_EXTENSION.

Note that the explicit version of this extension is still supported,
although it's somewhat less useful than the implicit one.

llvm-svn: 289158
2016-12-08 23:57:08 +00:00
..
DesignDocs [libc++] Introduce `_LIBCPP_OVERRIDABLE_FUNC_VIS` 2016-11-16 22:18:10 +00:00
BuildingLibcxx.rst Add start of filesystem benchmarks 2016-10-30 22:53:00 +00:00
CMakeLists.txt
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 Cleanup LIT testing doc 2016-10-14 06:15:27 +00:00
UsingLibcxx.rst Fix PR27374 - Remove the implicit reduced-arity-extension in tuple. 2016-12-08 23:57:08 +00:00
conf.py Update version numbers in docs 2016-05-03 22:50:33 +00:00
index.rst [libc++] Fix and document visibility attributes for Clang, GCC and Windows. 2016-09-15 22:27:07 +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.