Skip to content

Commit b570f82

Browse files
committed
docs: Add pointer to cmake caches for PGO
Also add a link to end-user PGO documentation. Differential Revision: https://reviews.llvm.org/D92768
1 parent 98f76ad commit b570f82

File tree

2 files changed

+13
-2
lines changed

2 files changed

+13
-2
lines changed

llvm/docs/HowToBuildWithPGO.rst

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ decrease overall compile time by 20%.
1212
This guide walks you through how to build Clang with PGO, though it also applies
1313
to other subprojects, such as LLD.
1414

15+
If you want to build other software with PGO, see the `end-user documentation
16+
for PGO <https://clang.llvm.org/docs/UsersManual.html#profile-guided-optimization>`_.
17+
18+
19+
Using preconfigured CMake caches
20+
================================
21+
22+
See https://llvm.org/docs/AdvancedBuilds.html#multi-stage-pgo
1523

1624
Using the script
1725
================
@@ -62,8 +70,8 @@ This is configurable in the script itself.
6270
Building Clang with PGO
6371
=======================
6472

65-
If you prefer to not use the script, this briefly goes over how to build
66-
Clang/LLVM with PGO.
73+
If you prefer to not use the script or the cmake cache, this briefly goes over
74+
how to build Clang/LLVM with PGO.
6775

6876
First, you should have at least LLVM, Clang, and compiler-rt checked out
6977
locally.

llvm/utils/collect_and_build_with_pgo.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
1111
This is a total of four clean builds of clang (by default). This may take a
1212
while. :)
13+
14+
This scripts duplicates https://llvm.org/docs/AdvancedBuilds.html#multi-stage-pgo
15+
Eventually, it will be updated to instead call the cmake cache mentioned there.
1316
"""
1417

1518
import argparse

0 commit comments

Comments
 (0)