maxjhandsome
/
llvm-project
forked from OSchip/llvm-project
1
0
Fork 0
Code Issues Pull Requests Packages Releases Wiki Activity
llvm-project/libunwind/docs
History
Ed Maste 48652257bb libunwind: document tested FreeBSD configs and sort OS list 
libunwind is known to work on FreeBSD i386, amd64 (x86_64) and arm64.
It is the unwinder provided by the base system on all of those
architectures.

While here sort the OS list.

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

llvm-svn: 315814
 		2017-10-14 17:04:04 +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 libunwind: document tested FreeBSD configs and sort OS list 2017-10-14 17:04:04 +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.