[PATCH] D92768: docs: Add pointer to cmake caches for PGO

Nico Weber via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Dec 7 12:55:53 PST 2020


This revision was automatically updated to reflect the committed changes.
Closed by commit rGb570f82f43a7: docs: Add pointer to cmake caches for PGO (authored by thakis).

Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D92768/new/

https://reviews.llvm.org/D92768

Files:
  llvm/docs/HowToBuildWithPGO.rst
  llvm/utils/collect_and_build_with_pgo.py


Index: llvm/utils/collect_and_build_with_pgo.py
===================================================================
--- llvm/utils/collect_and_build_with_pgo.py
+++ llvm/utils/collect_and_build_with_pgo.py
@@ -10,6 +10,9 @@
 
 This is a total of four clean builds of clang (by default). This may take a
 while. :)
+
+This scripts duplicates https://llvm.org/docs/AdvancedBuilds.html#multi-stage-pgo
+Eventually, it will be updated to instead call the cmake cache mentioned there.
 """
 
 import argparse
Index: llvm/docs/HowToBuildWithPGO.rst
===================================================================
--- llvm/docs/HowToBuildWithPGO.rst
+++ llvm/docs/HowToBuildWithPGO.rst
@@ -12,6 +12,14 @@
 This guide walks you through how to build Clang with PGO, though it also applies
 to other subprojects, such as LLD.
 
+If you want to build other software with PGO, see the `end-user documentation
+for PGO <https://clang.llvm.org/docs/UsersManual.html#profile-guided-optimization>`_.
+
+
+Using preconfigured CMake caches
+================================
+
+See https://llvm.org/docs/AdvancedBuilds.html#multi-stage-pgo
 
 Using the script
 ================
@@ -62,8 +70,8 @@
 Building Clang with PGO
 =======================
 
-If you prefer to not use the script, this briefly goes over how to build
-Clang/LLVM with PGO.
+If you prefer to not use the script or the cmake cache, this briefly goes over
+how to build Clang/LLVM with PGO.
 
 First, you should have at least LLVM, Clang, and compiler-rt checked out
 locally.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D92768.310000.patch
Type: text/x-patch
Size: 1530 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20201207/b2fe98a2/attachment.bin>


More information about the llvm-commits mailing list