summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorGregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) <greg@krypto.org>2016-09-08 18:37:59 +0000
committerGregory P. Smith ext:(%20%5BGoogle%20Inc.%5D) <greg@krypto.org>2016-09-08 18:37:59 +0000
commitc4f19c408ab62886c2b36f6b3d5b5f0e15d3c3df (patch)
treedc4fa1eea4a79c7e6542a48d1c97abee4772ed4b /README
parent280290adb8dc3d2337f5b2bc25b824d93a9434e8 (diff)
downloadcpython-git-c4f19c408ab62886c2b36f6b3d5b5f0e15d3c3df.tar.gz
document --with-optimizations in the README for issue26359.
Diffstat (limited to 'README')
-rw-r--r--README18
1 files changed, 13 insertions, 5 deletions
diff --git a/README b/README
index 778fdf9e00..61cf46b41a 100644
--- a/README
+++ b/README
@@ -173,10 +173,10 @@ rebuilt. In this case, you may have to run make again to correctly
build your desired target. The interpreter executable is built in the
top level directory.
-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 below.
+To get an optimized build of Python, "configure --with-optimizations" before
+you run make. This sets the default make targets up to enable Profile Guided
+Optimization (PGO) and Link Time Optimization (LTO) on most platforms.
+For more details, see the sections bellow.
Once you have built a Python interpreter, see the subsections below on
testing and installation. If you run into trouble, see the next
@@ -194,7 +194,7 @@ 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.
+If ran, "make profile-opt" will do several steps.
First, the entire Python directory is cleaned of temporary files that
may have resulted in a previous compilation.
@@ -214,6 +214,14 @@ collected in the previous one. The end result will be a Python binary
that is optimized and suitable for distribution or production installation.
+Link Time Optimization
+----------------------
+
+LTO takes advantages of recent compiler toolchains ability to optimize across
+the otherwise arbitrary .o file boundary when building final executables or
+shared libraries for additional performance gains.
+
+
Troubleshooting
---------------