summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGregory P. Smith <greg@krypto.org>2018-04-19 15:58:17 (GMT)
committerGitHub <noreply@github.com>2018-04-19 15:58:17 (GMT)
commitb87c1c92fc93c5733cd3d8606ab2301ca6ba208f (patch)
treea9ac9470682b2113dda610b00c6fb01a03a065e1
parent69524821a87251b7aee966f6e46b3810ff5aaa64 (diff)
downloadcpython-b87c1c92fc93c5733cd3d8606ab2301ca6ba208f.zip
cpython-b87c1c92fc93c5733cd3d8606ab2301ca6ba208f.tar.gz
cpython-b87c1c92fc93c5733cd3d8606ab2301ca6ba208f.tar.bz2
Clean up the readme text around PGO a bit. (GH-6538)
-rw-r--r--README.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 05daca2..5420558 100644
--- a/README.rst
+++ b/README.rst
@@ -92,15 +92,16 @@ below.
Profile Guided Optimization
^^^^^^^^^^^^^^^^^^^^^^^^^^^
-PGO takes advantage of recent versions of the GCC or Clang compilers. If ran,
-``make profile-opt`` will do several steps.
+PGO takes advantage of recent versions of the GCC or Clang compilers. If used,
+either via ``configure --enable-optimizations`` above or by manually running
+``make profile-opt`` regardless of configure flags it will do several steps.
First, the entire Python directory is cleaned of temporary files that may have
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
+compiler flags for each flavour. Note that this is just an intermediary step.
+The binary resulting from 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