summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2018-04-19 16:14:36 (GMT)
committerGregory P. Smith <greg@krypto.org>2018-04-19 16:14:36 (GMT)
commitdc654c53e516a31ca484e3fd82ace90602726c54 (patch)
treec4cb5bacf8249ac39a2e0a78c47e90a82287b857
parenta4fb580f701df5bf07ce569a4f43abfb05c92759 (diff)
downloadcpython-dc654c53e516a31ca484e3fd82ace90602726c54.zip
cpython-dc654c53e516a31ca484e3fd82ace90602726c54.tar.gz
cpython-dc654c53e516a31ca484e3fd82ace90602726c54.tar.bz2
Clean up the readme text around PGO a bit. (GH-6538) (GH-6539)
(cherry picked from commit b87c1c92fc93c5733cd3d8606ab2301ca6ba208f) Co-authored-by: Gregory P. Smith <greg@krypto.org>
-rw-r--r--README.rst9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.rst b/README.rst
index 607f261..fcd2344 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