-
Notifications
You must be signed in to change notification settings - Fork 14.4k
[libc] Fix broken links in libc #145199
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[libc] Fix broken links in libc #145199
Conversation
@llvm/pr-subscribers-libc Author: Shubh Pachchigar (shubhe25p) ChangesThis PR fixes broken links in all files describing libc usage modes. Please let me know if there are any other places that need updating. Full diff: https://github.com/llvm/llvm-project/pull/145199.diff 3 Files Affected:
diff --git a/libc/CMakeLists.txt b/libc/CMakeLists.txt
index 9907adfc55a5f..507b3aa88babf 100644
--- a/libc/CMakeLists.txt
+++ b/libc/CMakeLists.txt
@@ -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.
diff --git a/libc/docs/dev/code_style.rst b/libc/docs/dev/code_style.rst
index 86247966552f9..5eafff9ef9b3d 100644
--- a/libc/docs/dev/code_style.rst
+++ b/libc/docs/dev/code_style.rst
@@ -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
diff --git a/libc/examples/README.md b/libc/examples/README.md
index 1bc4a67294f2a..223d38da26c98 100644
--- a/libc/examples/README.md
+++ b/libc/examples/README.md
@@ -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),
+[full host build mode](https://libc.llvm.org/full_host_build.html) or
+[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
|
@michaelrj-google Can you please review or let me know what to do next? Thank you so much for your time. |
Thank you for submitting a Pull Request (PR) to the LLVM Project! This PR will be automatically labeled and the relevant teams will be notified. If you wish to, you can add reviewers by using the "Reviewers" section on this page. If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers. If you have further questions, they may be answered by the LLVM GitHub User Guide. You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the fix! Just a few grammar changes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the cleanup! Do you need me to merge this for you?
@michaelrj-google Thank you so much. I would really appreciate it if you could merge. I am not sure if I have the permission. |
@shubhe25p Congratulations on having your first Pull Request (PR) merged into the LLVM Project! Your changes will be combined with recent changes from other authors, then tested by our build bots. If there is a problem with a build, you may receive a report in an email or a comment on this PR. Please check whether problems have been caused by your change specifically, as the builds can include changes from many authors. It is not uncommon for your change to be included in a build that fails due to someone else's changes, or infrastructure issues. How to do this, and the rest of the post-merge process, is covered in detail here. If your change does cause a problem, it may be reverted, or you can revert it yourself. This is a normal part of LLVM development. You can fix your changes and open a new PR to merge them again. If you don't get any reports, no action is required from you. Your changes are working as expected, well done! |
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 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 PR fixes broken links in all files describing libc usage modes. Please let me know if there are any other places that need updating.