Skip to content

Commit

Permalink
pythongh-118518: Minor improvements to perf docs (pythonGH-130866)
Browse files Browse the repository at this point in the history
Minor improvements to perf docs
(cherry picked from commit ecdf6b1)

Co-authored-by: stratakis <[email protected]>
  • Loading branch information
stratakis authored and miss-islington committed Mar 10, 2025
1 parent cf829f4 commit c7a085c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions Doc/howto/perf_profiling.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`:
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit c7a085c

Please sign in to comment.