llvm-capstone

mirror of https://github.com/capstone-engine/llvm-capstone.git synced 2024-12-22 15:31:00 +00:00

History

Eric Fiselier d981977d5a Add design docs for upcoming file_time_type change. In upcoming changes to filesystem I plan to change file_time_type to use __int128_t as its underlying representation, in order to allow it to have a range and resolution at least that of the timespec struct. There was some pushback against this decision, so I drafted a document explaining the problems, potential solutions, and the rational for the decision. However, it's probably easier to let people read the generated HTML rather than the raw restructured text. For this reason I'm commiting the design documents before hand, so they can be available during any subsequent discussion or code review. llvm-svn: 337880		2018-07-25 02:53:53 +00:00
..
DesignDocs	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
BuildingLibcxx.rst	Corrected a typo in the building libc++ docs	2017-12-03 10:18:35 +00:00
CMakeLists.txt	docs: Fix Sphinx detection with out-of-tree builds	2017-05-09 11:18:03 +00:00
conf.py	Update version to 7.0.0svn: cmake, include files and docs	2018-01-03 15:40:29 +00:00
index.rst	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
Makefile.sphinx	Add design docs for upcoming file_time_type change.	2018-07-25 02:53:53 +00:00
README.txt
TestingLibcxx.rst	Teach test suite about C++2a dialect flag.	2017-11-07 20:26:23 +00:00
UsingLibcxx.rst	[libc++] Support Microsoft ABI without vcruntime headers	2017-10-09 19:25:17 +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.