From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Fri, 28 Mar 2025 11:42:58 +0000 (+0100)
Subject: [3.13] gh-118518: Minor improvements to perf docs (GH-130866) (#131059)
X-Git-Tag: v3.13.3~71
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7f7fc549b4d8c727e3e3da97b43db15e0083f6ab;p=thirdparty%2FPython%2Fcpython.git

[3.13] gh-118518: Minor improvements to perf docs (GH-130866) (#131059)

gh-118518: Minor improvements to perf docs (GH-130866)

Minor improvements to perf docs
(cherry picked from commit ecdf6b15b0c0570c3c3302ab95bdbfd3007ea941)

Co-authored-by: stratakis <cstratak@redhat.com>
---

diff --git a/Doc/howto/perf_profiling.rst b/Doc/howto/perf_profiling.rst
index 06459d1b2229..4cec8f62aeba 100644
--- a/Doc/howto/perf_profiling.rst
+++ b/Doc/howto/perf_profiling.rst
@@ -162,12 +162,12 @@ the :option:`!-X` option takes precedence over the environment variable.
 
 Example, using the environment variable::
 
-   $ PYTHONPERFSUPPORT=1 perf record -F 9999 -g -o perf.data python script.py
+   $ PYTHONPERFSUPPORT=1 perf record -F 9999 -g -o perf.data python my_script.py
    $ perf report -g -i perf.data
 
 Example, using the :option:`!-X` option::
 
-   $ perf record -F 9999 -g -o perf.data python -X perf script.py
+   $ perf record -F 9999 -g -o perf.data python -X perf my_script.py
    $ perf report -g -i perf.data
 
 Example, using the :mod:`sys` APIs in file :file:`example.py`:
@@ -236,7 +236,7 @@ When using the perf JIT mode, you need an extra step before you can run ``perf
 report``. You need to call the ``perf inject`` command to inject the JIT
 information into the ``perf.data`` file.::
 
-    $ perf record -F 9999 -g --call-graph dwarf -o perf.data python -Xperf_jit my_script.py
+    $ perf record -F 9999 -g -k 1 --call-graph dwarf -o perf.data python -Xperf_jit my_script.py
     $ perf inject -i perf.data --jit --output perf.jit.data
     $ perf report -g -i perf.jit.data