llvm-project/libunwind/docs
Martin Storsjo 3920189bcc [docs] Mention that dwarf unwinding should be supported on arm64/windows
This didn't require any further changes to libunwind as long as win64
in general is handled correctly.

Differential Revision: https://reviews.llvm.org/D39632

llvm-svn: 318383
2017-11-16 07:16:36 +00:00
..
BuildingLibunwind.rst
CMakeLists.txt
README.txt
conf.py Bump docs version to 6.0 2017-07-19 13:49:39 +00:00
index.rst [docs] Mention that dwarf unwinding should be supported on arm64/windows 2017-11-16 07:16:36 +00:00

README.txt

libunwind Documentation
====================

The libunwind documentation is written using the Sphinx documentation generator. It is
currently tested with Sphinx 1.1.3.

To build the documents into html configure libunwind with the following cmake options:

  * -DLLVM_ENABLE_SPHINX=ON
  * -DLIBUNWIND_INCLUDE_DOCS=ON

After configuring libunwind with these options the make rule `docs-libunwind-html`
should be available.