mirror-llvm-project/libc/docs
Joseph Huber 1a318e7277 [libc] Tweak the runtimes cross-build for GPU (#178548)
Summary:
We should likely use `-DLLVM_DEFAULT_TARGET_TRIPLE` as the general
source of truth, make the handling work with that since we use it for
the output directories. Fix the creation of startup files in this mode
and make sure it can detect the GPU properly.

Fixes: https://github.com/llvm/llvm-project/issues/179375
(cherry picked from commit e07a1182fd)
2026-02-04 09:34:09 +00:00
..
_static
dev [libc] Split out src/__support/alloc-checker.h (#173104) 2025-12-22 11:04:33 -08:00
gpu [libc] Tweak the runtimes cross-build for GPU (#178548) 2026-02-04 09:34:09 +00:00
headers [libc][POSIX] Add clock_settime() function for Linux (#161729) 2025-11-11 09:54:34 -08:00
uefi [libc] [NFC] fix type in docs/uefi/index.rst (#132553) 2025-03-22 12:16:15 -07:00
arch_support.rst [libc][docs] split up platform and arch support (#120125) 2024-12-16 15:17:18 -08:00
build_and_test.rst [libc][docs] Update VSCode instructions for full host build (#162626) 2025-10-09 17:10:47 +00:00
check.rst
CMakeLists.txt [libc][docs] Add a sunset policy to porting docs (#168936) 2025-12-11 09:29:26 -08:00
compiler_support.rst
conf.py [libc][docs] add redirect for math/index.html (#120274) 2024-12-17 10:37:21 -08:00
configure.rst [libc][math] Add LIBC_CONF_MATH_USE_SYSTEM_FENV / LIBC_MATH_USE_SYSTEM_FENV (#172902) 2025-12-22 13:19:56 -05:00
contributing.rst
full_cross_build.rst [libc] Move hdrgen into utils/ subdirectory (#121256) 2024-12-30 15:36:53 -08:00
full_host_build.rst [libc][docs] update docs on how to build linux kernel headers from src (#122381) 2025-01-10 14:40:57 -08:00
getting_started.rst [libc] add uefi docs (#131426) 2025-03-16 10:21:19 -07:00
hand_in_hand.rst [libc][docs] Fix typo (#174631) 2026-01-06 10:53:17 -08:00
index.rst [libc][docs] Update website to reflect new strategy (#168637) 2025-12-19 22:12:31 +00:00
Maintainers.rst [libc] Add maintainers file (#133471) 2025-03-28 16:50:19 -07:00
overlay_mode.rst
platform_support.rst [libc][NFC] Strip all training whitespace and missing newlines (#124163) 2025-01-23 12:02:54 -06:00
porting.rst [libc][docs] Add a sunset policy to porting docs (#168936) 2025-12-11 09:29:26 -08:00
README.txt
talks.rst [libc][docs] Add links to 2025 talks. (#170206) 2025-12-01 16:45:21 -05:00

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.