shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions 6 Packages Projects Releases Wiki Activity
llvm-project/libc/docs
History
Jeff Bailey f493b21e16 [libc] Update look and feel of libc.llvm.org 
This design is borrowed from the lldb folks (thank you!) to declutter
the page.

 * The version number at the top is removed.
 * Links are pushed over to a sidebar
 * The sidebar has headings

There are other minor changes:

* The warning about this project not being ready is now an RST "warning"
* Links to the Bug Reports and the Source Code are Added
* Refer to this project as either "The LLVM C LIbrary" or "The libc"

Tested:
Built locally

Reviewed By: sivachandra

Differential Revision: https://reviews.llvm.org/D131242
2022-08-05 18:18:40 +00:00
..
_static
[libc] Update look and feel of libc.llvm.org
2022-08-05 18:18:40 +00:00
api_test.rst
[libc] Rename libc-integration-test to libc-api-test.
2022-03-23 20:25:34 +00:00
build_system.rst
…
clang_tidy_checks.rst
[libc][clang-tidy] fix namespace check for externals
2021-11-30 11:44:24 -08:00
CMakeLists.txt
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00:00
conf.py
[libc] Update look and feel of libc.llvm.org
2022-08-05 18:18:40 +00:00
entrypoints.rst
…
fuzzing.rst
[libc][docs] Update the fuzzing doc to better reflect the current state.
2022-04-20 15:33:20 +00:00
ground_truth_specification.rst
…
header_gen_scheme.svg
…
header_generation.rst
[libc] NFC: Fix trivial typo in comments, documents, and messages
2020-04-06 16:19:34 +09:00
implementation_standard.rst
[libc] NFC: Fix trivial typo in comments, documents, and messages
2020-04-06 16:19:34 +09:00
index.rst
[libc] Update look and feel of libc.llvm.org
2022-08-05 18:18:40 +00:00
layering.rst
Rewrite much of the index page for libc
2022-02-16 03:46:20 +00:00
math.rst
[libc] Implement sincosf function correctly rounded to all rounding modes.
2022-08-05 09:58:01 -04:00
mechanics_of_public_api.rst
…
README.txt
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00:00
redirectors_schematic.svg
…
redirectors.rst
Move LLVM Proposal to doc directory, create index
2022-01-29 00:29:31 +00:00
runtimes_build.rst
[libc] Add a doc describing the current status of libc runtimes build.
2022-04-18 06:48:43 +00:00
source_layout.rst
[libc][docs] Use same formatting for headers in source_layout
2022-05-23 21:47:22 +00:00
stdio.rst
[libc][docs] Add doc for libc stdio functions
2022-05-12 13:02:23 -07:00
strings.rst
[libc][docs] Add doc for libc stdio functions
2022-05-12 13:02:23 -07: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
  * -DLIBC_INCLUDE_DOCS=ON

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