summaryrefslogtreecommitdiffstats
path: root/Doc/howto
diff options
context:
space:
mode:
authorHugo van Kemenade <1324225+hugovk@users.noreply.github.com>2024-05-07 11:47:21 (GMT)
committerGitHub <noreply@github.com>2024-05-07 11:47:21 (GMT)
commit04859228aa11756558807bcf99ccff78e4e8c56d (patch)
tree050ba0bb7abecaa1b007267a774e07bcfa1f1f99 /Doc/howto
parent48e52fe2c9a7b33671f6b5d1420a71a6f31ad64b (diff)
downloadcpython-04859228aa11756558807bcf99ccff78e4e8c56d.zip
cpython-04859228aa11756558807bcf99ccff78e4e8c56d.tar.gz
cpython-04859228aa11756558807bcf99ccff78e4e8c56d.tar.bz2
gh-118518: Rename `PYTHONPERFJITSUPPORT` and `-X perfjit` with underscores (#118693)
Diffstat (limited to 'Doc/howto')
-rw-r--r--Doc/howto/perf_profiling.rst8
1 files changed, 4 insertions, 4 deletions
diff --git a/Doc/howto/perf_profiling.rst b/Doc/howto/perf_profiling.rst
index 0ce66f3..ed2b76f 100644
--- a/Doc/howto/perf_profiling.rst
+++ b/Doc/howto/perf_profiling.rst
@@ -216,19 +216,19 @@ needs to generate unwinding information for every Python function call on the fl
``perf`` will take more time to process the data because it will need to use the DWARF debugging
information to unwind the stack and this is a slow process.
-To enable this mode, you can use the environment variable :envvar:`PYTHONPERFJITSUPPORT` or the
-:option:`-X perfjit <-X>` option, which will enable the JIT mode for the ``perf`` profiler.
+To enable this mode, you can use the environment variable :envvar:`PYTHON_PERF_JIT_SUPPORT` or the
+:option:`-X perf_jit <-X>` option, which will enable the JIT mode for the ``perf`` profiler.
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 -Xperfjit my_script.py
+ $ perf record -F 9999 -g --call-graph dwarf -o perf.data python -Xperf_jit my_script.py
$ perf inject -i perf.data --jit
$ perf report -g -i perf.data
or using the environment variable::
- $ PYTHONPERFJITSUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
+ $ PYTHON_PERF_JIT_SUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
$ perf inject -i perf.data --jit
$ perf report -g -i perf.data