summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorBrett Cannon <brett@python.org>2015-09-18 15:17:37 -0700
committerBrett Cannon <brett@python.org>2015-09-18 15:17:37 -0700
commit01253403eeb29dc12f5d95c961a76f30e40b865a (patch)
treec5e9cad722dd014322082e349e71cc7cea82589f /README
parentc6b4296f9881130673b255be15b521b9d098141b (diff)
parent5f6fd63f998e32bbe732fe7e9ac3d3de4841e37b (diff)
downloadcpython-01253403eeb29dc12f5d95c961a76f30e40b865a.tar.gz
Merge for issue #24915
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
index db0b093d12..d682a2bdd3 100644
--- a/README
+++ b/README
@@ -46,6 +46,34 @@ For example:
(This will fail if you *also* built at the top-level directory.
You should do a "make clean" at the toplevel first.)
+If you need an optimized version of Python, you type "make profile-opt" in the
+top level directory. This will rebuild the interpreter executable using Profile
+Guided Optimization (PGO). For more details, see the section bellow.
+
+
+Profile Guided Optimization
+---------------------------
+
+PGO takes advantage of recent versions of the GCC or Clang compilers.
+If ran, the "profile-opt" rule will do several steps.
+
+First, the entire Python directory is cleaned of temporary files that
+may resulted in a previous compilation.
+
+Then, an instrumented version of the interpreter is built, using suitable
+compiler flags for each flavour. Note that this is just an intermediary
+step and the binary resulted after this step is not good for real life
+workloads, as it has profiling instructions embedded inside.
+
+After this instrumented version of the interpreter is built, the Makefile
+will automatically run a training workload. This is necessary in order to
+profile the interpreter execution. Note also that any output, both stdout
+and stderr, that may appear at this step is supressed.
+
+Finally, the last step is to rebuild the interpreter, using the information
+collected in the previous one. The end result will be a the Python binary
+that is optimized and suitable for distribution or production installation.
+
What's New
----------