From 6444dd793eb2b92bf07746795f45b7464b7d4bf7 Mon Sep 17 00:00:00 2001 From: "Miss Islington (bot)" <31488909+miss-islington@users.noreply.github.com> Date: Fri, 20 Apr 2018 10:15:20 -0700 Subject: [PATCH] Clean up the readme text around PGO a bit. (GH-6538) (#6540) (cherry picked from commit b87c1c92fc93c5733cd3d8606ab2301ca6ba208f) Co-authored-by: Gregory P. Smith --- README.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 6ef60a1f662..095cc4b0aa4 100644 --- a/README.rst +++ b/README.rst @@ -91,15 +91,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