shylie/llvm-project
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[libc] Fix broken links in libc (#145199)

Browse Source 
This PR fixes broken links in all files describing libc usage modes.
Please let me know if there are any other places that need updating.

---------

Co-authored-by: shubhp@perlmutter <shubhp@perlmutter.com>
This commit is contained in:
Shubh Pachchigar 2025-06-23 15:51:43 -07:00 committed by GitHub
parent d37325ea95
commit 98e8ef2273
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
libc/CMakeLists.txt
View File

@ -4,7 +4,7 @@ set(LLVM_SUBPROJECT_TITLE "libc")
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
message(FATAL_ERROR "Builds rooted in the libc directory are not supported. "
"Builds should be rooted in the runtimes directory instead. "
"Please see the documentation at https://libc.llvm.org/usage_modes.html for more info.")
"Please see the documentation at https://libc.llvm.org/build_and_test.html for more info.")
endif()
# Include LLVM's cmake policies.

7
libc/docs/dev/code_style.rst
View File

@ -191,9 +191,10 @@ Header Inclusion Policy
=======================
Because llvm-libc supports
`Overlay Mode <https://libc.llvm.org/overlay_mode.html>`__ and
`Fullbuild Mode <https://libc.llvm.org/fullbuild_mode.html>`__ care must be
taken when ``#include``'ing certain headers.
`Overlay Mode <https://libc.llvm.org/overlay_mode.html>`__,
`Full Host Build Mode <https://libc.llvm.org/full_host_build.html>`__ and
`Full Cross Build Mode <https://libc.llvm.org/full_cross_build.html>`__ care
must be taken when ``#include``'ing certain headers.
The ``include/`` directory contains public facing headers that users must
consume for fullbuild mode. As such, types defined here will have ABI

10
libc/examples/README.md
View File

@ -3,7 +3,7 @@ Examples
This directory contains a few example programs which illustrate how one can set
up their own projects to use LLVM's libc, either as an overlay or as the only
libc in their projects. See the
[the usage mode document](https://libc.llvm.org/usage_modes.html) for more
[the usage mode document](https://libc.llvm.org/build_and_test.html) for more
information about the different modes in which one can build and use the libc.
Building the Examples
@ -19,8 +19,9 @@ cd build
```
Each example can be built to use the libc in either
[the overlay mode](https://libc.llvm.org/overlay_mode.html) or the
[full build mode](https://libc.llvm.org/fullbuild_mode.html). The CMake
[the overlay mode](https://libc.llvm.org/overlay_mode.html), the
[full host build mode](https://libc.llvm.org/full_host_build.html) or the
[full cross build mode](https://libc.llvm.org/full_cross_build.html). The CMake
configure step differs slightly depending on the mode you want to use the libc
in.
@ -49,7 +50,8 @@ Building against a full libc
----------------------------
Before you can link an example against the full libc, you will have to first
install it. See [the documentation of the full build mode](https://libc.llvm.org/fullbuild_mode.html)
install it. See [documentation for full host build mode](https://libc.llvm.org/full_host_build.html)
or [documentation for full cross build mode](https://libc.llvm.org/full_cross_build.html)
to learn how to install a full libc along with the other LLVM toolchain pieces
like `clang`, `lld` and `compiler-rt`. The CMake build for the examples will
assume that you have all of these components installed in a special sysroot