forked from OSchip/llvm-project
4ae83bb2b1
We are moving away from building the runtimes with LLVM_ENABLE_PROJECTS, however the documentation was largely outdated. This commit updates all the documentation I could find to use LLVM_ENABLE_RUNTIMES instead of LLVM_ENABLE_PROJECTS for building runtimes. Note that in the near future, libcxx, libcxxabi and libunwind will stop supporting being built with LLVM_ENABLE_PROJECTS altogether. I don't know what the plans are for other runtimes like libc, openmp and compiler-rt, so I didn't make any changes to the documentation that would imply something for those projects. Once this lands, I will also cherry-pick this on the release/14.x branch to make sure that LLVM's documentation is up-to-date and reflects what we intend to support in the future. Differential Revision: https://reviews.llvm.org/D119351 |
||
|---|---|---|
| .. | ||
| BuildingLibunwind.rst | ||
| CMakeLists.txt | ||
| README.txt | ||
| conf.py | ||
| index.rst | ||
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.