llvm-capstone/libc/docs
Michael Jones 99686c5ed1 [libc][docs] Add undefined behavior doc to site
This document is based on the RFC posted to discourse:
https://discourse.llvm.org/t/rfc-defining-undefined-behavior-in-libc/

Reviewed By: sivachandra, lntue

Differential Revision: https://reviews.llvm.org/D152588
2023-06-12 11:13:51 -07:00
..
_static
dev [libc][docs] Add undefined behavior doc to site 2023-06-12 11:13:51 -07:00
gpu [libc][Docs] Add support for the printing functions 2023-06-06 14:33:08 -05:00
math [libc][RISCV] Add log, log2, log1p, log10 for RISC-V64 entrypoints. 2023-05-30 14:18:19 -04:00
build_and_test.rst
check.rst
CMakeLists.txt
compiler_support.rst [libc] Fix typos in documentation 2023-05-06 11:26:32 -07:00
conf.py [NFC][Py Reformat] Reformat python files in the rest of the dirs 2023-05-25 11:17:05 +02:00
contributing.rst [libc] Fix typos in documentation 2023-04-24 23:31:48 -07:00
date_and_time.rst [libc][docs] Update implementation status table for Date and Time Functions. 2023-05-31 15:09:06 -04:00
full_cross_build.rst [libc] Add two more recipes to do a cross build. 2023-04-18 12:40:14 -07:00
full_host_build.rst [libc] Add instructions for linux headers 2023-03-15 03:02:16 +00:00
fullbuild_mode.rst
header_gen_scheme.svg
index.rst [libc][Docs] Begin improving documentation for the GPU libc 2023-04-26 10:30:54 -05:00
overlay_mode.rst [libc] Fix typos in documentation 2023-04-24 23:31:48 -07:00
porting.rst [libc] Fix typos in documentation 2023-04-24 23:31:48 -07:00
README.txt
stdio.rst [libc] Add implementation of getchar 2023-04-14 15:40:05 -07:00
strings.rst
usage_modes.rst

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
  * -DLIBC_INCLUDE_DOCS=ON

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