Bug 1412356 - Update docs on PGO builds to not reference client.mk; r?build-peer draft
authorGregory Szorc <gps@mozilla.com>
Fri, 27 Oct 2017 10:14:40 -0700
changeset 687744 372da97db508ce998553ed7b28857671c2560572
parent 687743 c2e14a9ff7d9dc37305fbe1d25916a58d4f66a6e
child 687745 d4dee08ec4caee5adac2340c9b32564882be2265
push id86586
push usergszorc@mozilla.com
push dateFri, 27 Oct 2017 17:20:01 +0000
reviewersbuild-peer
bugs1412356
milestone58.0a1
Bug 1412356 - Update docs on PGO builds to not reference client.mk; r?build-peer As part of moving away from client.mk. MozReview-Commit-ID: IMeM0k1tTsS
build/docs/pgo.rst
--- a/build/docs/pgo.rst
+++ b/build/docs/pgo.rst
@@ -7,26 +7,22 @@ Profile Guided Optimization
 :abbr:`PGO (Profile Guided Optimization)` is the process of adding
 probes to a compiled binary, running said binary, then using the
 run-time information to *recompile* the binary to (hopefully) make it
 faster.
 
 How PGO Builds Work
 ===================
 
-The supported interface for invoking a PGO build is to evaluate the
-*build* target of client.mk with *MOZ_PGO* defined. e.g.::
-
-    $ make -f client.mk MOZ_PGO=1
+The supported interface for invoking a PGO build is to invoke the build system
+with ``MOZ_PGO`` defined. e.g.::
 
-This is equivalent to::
+    $ MOZ_PGO=1 ./mach build
 
-    $ make -f client.mk profiledbuild
-
-Which is roughly equivalent to:
+This is roughly equivalent to::
 
 #. Perform a build with *MOZ_PROFILE_GENERATE=1* and *MOZ_PGO_INSTRUMENTED=1*
 #. Package with *MOZ_PGO_INSTRUMENTED=1*
 #. Performing a run of the instrumented binaries
 #. $ make maybe_clobber_profiledbuild
 #. Perform a build with *MOZ_PROFILE_USE=1*
 
 Differences between toolchains