Skip to content

Commit

Permalink
docs: Add pointer to cmake caches for PGO
Browse files Browse the repository at this point in the history
Also add a link to end-user PGO documentation.

Differential Revision: https://reviews.llvm.org/D92768
  • Loading branch information
nico committed Dec 7, 2020
1 parent 98f76ad commit b570f82
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 2 deletions.
12 changes: 10 additions & 2 deletions llvm/docs/HowToBuildWithPGO.rst
Expand Up @@ -12,6 +12,14 @@ decrease overall compile time by 20%.
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
================
Expand Down Expand Up @@ -62,8 +70,8 @@ This is configurable in the script itself.
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.
Expand Down
3 changes: 3 additions & 0 deletions llvm/utils/collect_and_build_with_pgo.py
Expand Up @@ -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
Expand Down

0 comments on commit b570f82

Please sign in to comment.