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

[Nico Weber via Phabricator via llvm-commits]

thakis created this revision.
thakis added a reviewer: george.burgess.iv.
Herald added a subscriber: wenlei.
thakis requested review of this revision.
Herald added a project: LLVM.

The script has better SEO, but it's usually not what I want. Add a pointer for future self :)


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
@@ -13,6 +13,11 @@
 to other subprojects, such as LLD.
 
 
+Using preconfigured CMake caches
+================================
+
+See https://llvm.org/docs/AdvancedBuilds.html#multi-stage-pgo
+
 Using the script
 ================
 
@@ -62,8 +67,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.309925.patch
Type: text/x-patch
Size: 1282 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20201207/5d5cfb2e/attachment.bin>