summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorBrett Cannon <brett@python.org>2015-09-18 22:13:44 (GMT)
committerBrett Cannon <brett@python.org>2015-09-18 22:13:44 (GMT)
commit7188a3efe07b9effdb760f3a96783f250214f0be (patch)
tree2b422749dfe46aab0afd16cb2cb017f428e23380 /README
parent4b363e270108edb2be306aad3da3140e64637641 (diff)
downloadcpython-7188a3efe07b9effdb760f3a96783f250214f0be.zip
cpython-7188a3efe07b9effdb760f3a96783f250214f0be.tar.gz
cpython-7188a3efe07b9effdb760f3a96783f250214f0be.tar.bz2
Issue #24915: Add Clang support to PGO builds and use the test suite
for profile data. Thanks to Alecsandru Patrascu of Intel for the initial patch.
Diffstat (limited to 'README')
-rw-r--r--README28
1 files changed, 28 insertions, 0 deletions
diff --git a/README b/README
index d37b96b..82d1697 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
----------