[clang] f9ea86e - [Docs] Add the entry for `Advanced builds` in UserGuide.rst
Yuanfang Chen via cfe-commits
cfe-commits at lists.llvm.org
Thu Jun 4 14:53:29 PDT 2020
Author: Yuanfang Chen
Date: 2020-06-04T14:52:51-07:00
New Revision: f9ea86eaa1a3ba18973666c4de56dfde8d488574
URL: https://github.com/llvm/llvm-project/commit/f9ea86eaa1a3ba18973666c4de56dfde8d488574
DIFF: https://github.com/llvm/llvm-project/commit/f9ea86eaa1a3ba18973666c4de56dfde8d488574.diff
LOG: [Docs] Add the entry for `Advanced builds` in UserGuide.rst
Also add a link to it from ThinLTO.rst.
Added:
Modified:
clang/docs/ThinLTO.rst
llvm/docs/UserGuides.rst
Removed:
################################################################################
diff --git a/clang/docs/ThinLTO.rst b/clang/docs/ThinLTO.rst
index 2d5d0a71fa6b..528530c5ae98 100644
--- a/clang/docs/ThinLTO.rst
+++ b/clang/docs/ThinLTO.rst
@@ -194,7 +194,8 @@ Possible key-value pairs are:
Clang Bootstrap
---------------
-To bootstrap clang/LLVM with ThinLTO, follow these steps:
+To `bootstrap clang/LLVM <https://llvm.org/docs/AdvancedBuilds.html#bootstrap-builds>`_
+with ThinLTO, follow these steps:
1. The host compiler_ must be a version of clang that supports ThinLTO.
#. The host linker_ must support ThinLTO (and in the case of gold, must be
@@ -225,7 +226,7 @@ To bootstrap clang/LLVM with ThinLTO, follow these steps:
``CMAKE_EXE_LINKER_FLAGS:STRING=``. Note the configure may fail if
linker plugin options are instead specified directly in the previous step.
-The `BOOTSTRAP_LLVM_ENABLE_LTO=Thin`` will enable ThinLTO for stage 2 and
+The ``BOOTSTRAP_LLVM_ENABLE_LTO=Thin`` will enable ThinLTO for stage 2 and
stage 3 in case the compiler used for stage 1 does not support the ThinLTO
option.
diff --git a/llvm/docs/UserGuides.rst b/llvm/docs/UserGuides.rst
index 0b91b3cbe66d..6e4329128fab 100644
--- a/llvm/docs/UserGuides.rst
+++ b/llvm/docs/UserGuides.rst
@@ -96,7 +96,10 @@ LLVM Builds and Distributions
:doc:`Support Library <SupportLibrary>`
This document describes the LLVM Support Library (``lib/Support``) and
- how to keep LLVM source code portable
+ how to keep LLVM source code portable.
+
+:doc:`AdvancedBuilds`
+ This document describes more advanced build configurations.
Optimizations
-------------
More information about the cfe-commits
mailing list