Skip to content

Commit 98e8ef2

Browse files
shubhe25pshubhp@perlmutter
andauthored
[libc] Fix broken links in libc (#145199)
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 <[email protected]>
1 parent d37325e commit 98e8ef2

File tree

3 files changed

+11
-8
lines changed

3 files changed

+11
-8
lines changed

libc/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ set(LLVM_SUBPROJECT_TITLE "libc")
44
if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR)
55
message(FATAL_ERROR "Builds rooted in the libc directory are not supported. "
66
"Builds should be rooted in the runtimes directory instead. "
7-
"Please see the documentation at https://libc.llvm.org/usage_modes.html for more info.")
7+
"Please see the documentation at https://libc.llvm.org/build_and_test.html for more info.")
88
endif()
99

1010
# Include LLVM's cmake policies.

libc/docs/dev/code_style.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,10 @@ Header Inclusion Policy
191191
=======================
192192

193193
Because llvm-libc supports
194-
`Overlay Mode <https://libc.llvm.org/overlay_mode.html>`__ and
195-
`Fullbuild Mode <https://libc.llvm.org/fullbuild_mode.html>`__ care must be
196-
taken when ``#include``'ing certain headers.
194+
`Overlay Mode <https://libc.llvm.org/overlay_mode.html>`__,
195+
`Full Host Build Mode <https://libc.llvm.org/full_host_build.html>`__ and
196+
`Full Cross Build Mode <https://libc.llvm.org/full_cross_build.html>`__ care
197+
must be taken when ``#include``'ing certain headers.
197198

198199
The ``include/`` directory contains public facing headers that users must
199200
consume for fullbuild mode. As such, types defined here will have ABI

libc/examples/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Examples
33
This directory contains a few example programs which illustrate how one can set
44
up their own projects to use LLVM's libc, either as an overlay or as the only
55
libc in their projects. See the
6-
[the usage mode document](https://libc.llvm.org/usage_modes.html) for more
6+
[the usage mode document](https://libc.llvm.org/build_and_test.html) for more
77
information about the different modes in which one can build and use the libc.
88

99
Building the Examples
@@ -19,8 +19,9 @@ cd build
1919
```
2020

2121
Each example can be built to use the libc in either
22-
[the overlay mode](https://libc.llvm.org/overlay_mode.html) or the
23-
[full build mode](https://libc.llvm.org/fullbuild_mode.html). The CMake
22+
[the overlay mode](https://libc.llvm.org/overlay_mode.html), the
23+
[full host build mode](https://libc.llvm.org/full_host_build.html) or the
24+
[full cross build mode](https://libc.llvm.org/full_cross_build.html). The CMake
2425
configure step differs slightly depending on the mode you want to use the libc
2526
in.
2627

@@ -49,7 +50,8 @@ Building against a full libc
4950
----------------------------
5051

5152
Before you can link an example against the full libc, you will have to first
52-
install it. See [the documentation of the full build mode](https://libc.llvm.org/fullbuild_mode.html)
53+
install it. See [documentation for full host build mode](https://libc.llvm.org/full_host_build.html)
54+
or [documentation for full cross build mode](https://libc.llvm.org/full_cross_build.html)
5355
to learn how to install a full libc along with the other LLVM toolchain pieces
5456
like `clang`, `lld` and `compiler-rt`. The CMake build for the examples will
5557
assume that you have all of these components installed in a special sysroot

0 commit comments

Comments
 (0)