Skip to content

Commit d454f29

Browse files
committed
Rename PYTHONPERFJITSUPPORT to use underscores: PYTHON_PERF_JIT_SUPPORT
1 parent de1428f commit d454f29

File tree

6 files changed

+13
-13
lines changed

6 files changed

+13
-13
lines changed

Doc/c-api/init_config.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,10 +1250,10 @@ PyConfig
12501250
If non-zero, initialize the perf trampoline. See :ref:`perf_profiling`
12511251
for more information.
12521252
1253-
Set by :option:`-X perf <-X>` command line option and by the
1254-
:envvar:`PYTHONPERFSUPPORT` environment variable for perf support
1255-
with stack pointers and :option:`-X perfjit <-X>` command line option
1256-
and by the :envvar:`PYTHONPERFJITSUPPORT` environment variable for perf
1253+
Set by :option:`-X perf <-X>` command-line option and by the
1254+
:envvar:`PYTHON_PERF_JIT_SUPPORT` environment variable for perf support
1255+
with stack pointers and :option:`-X perfjit <-X>` command-line option
1256+
and by the :envvar:`PYTHON_PERF_JIT_SUPPORT` environment variable for perf
12571257
support with DWARF JIT information.
12581258
12591259
Default: ``-1``.

Doc/howto/perf_profiling.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ needs to generate unwinding information for every Python function call on the fl
216216
``perf`` will take more time to process the data because it will need to use the DWARF debugging
217217
information to unwind the stack and this is a slow process.
218218

219-
To enable this mode, you can use the environment variable :envvar:`PYTHONPERFJITSUPPORT` or the
219+
To enable this mode, you can use the environment variable :envvar:`PYTHON_PERF_JIT_SUPPORT` or the
220220
:option:`-X perfjit <-X>` option, which will enable the JIT mode for the ``perf`` profiler.
221221

222222
When using the perf JIT mode, you need an extra step before you can run ``perf report``. You need to
@@ -228,7 +228,7 @@ call the ``perf inject`` command to inject the JIT information into the ``perf.d
228228

229229
or using the environment variable::
230230

231-
$ PYTHONPERFJITSUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
231+
$ PYTHON_PERF_JIT_SUPPORT=1 perf record -F 9999 -g --call-graph dwarf -o perf.data python my_script.py
232232
$ perf inject -i perf.data --jit
233233
$ perf report -g -i perf.data
234234

Doc/using/cmdline.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -589,9 +589,9 @@ Miscellaneous options
589589

590590
* ``-X perfjit`` enables support for the Linux ``perf`` profiler with DWARF
591591
support. When this option is provided, the ``perf`` profiler will be able
592-
to report Python calls using DWARF ifnormation. This option is only available on
592+
to report Python calls using DWARF information. This option is only available on
593593
some platforms and will do nothing if is not supported on the current
594-
system. The default value is "off". See also :envvar:`PYTHONPERFJITSUPPORT`
594+
system. The default value is "off". See also :envvar:`PYTHON_PERF_JIT_SUPPORT`
595595
and :ref:`perf_profiling`.
596596

597597
.. versionadded:: 3.13
@@ -1137,7 +1137,7 @@ conflict.
11371137

11381138
.. versionadded:: 3.12
11391139

1140-
.. envvar:: PYTHONPERFJITSUPPORT
1140+
.. envvar:: PYTHON_PERF_JIT_SUPPORT
11411141

11421142
If this variable is set to a nonzero value, it enables support for
11431143
the Linux ``perf`` profiler so Python calls can be detected by it

Doc/whatsnew/3.13.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ Other Language Changes
272272

273273
* Add :ref:`support for the perf profiler <perf_profiling>` working without
274274
frame pointers through the new environment variable
275-
:envvar:`PYTHONPERFJITSUPPORT` and command-line option :option:`-X perfjit
275+
:envvar:`PYTHON_PERF_JIT_SUPPORT` and command-line option :option:`-X perfjit
276276
<-X>` (Contributed by Pablo Galindo in :gh:`118518`.)
277277

278278
* The new :envvar:`PYTHON_HISTORY` environment variable can be used to change
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
Allow the Linux perf support to work without frame pointers using perf's
22
advanced JIT support. The feature is activated when using the
3-
``PYTHONPERFJITSUPPORT`` environment variable or when running Python with
4-
``-Xperfjit``. Patch by Pablo Galindo
3+
``PYTHON_PERF_JIT_SUPPORT`` environment variable or when running Python with
4+
``-Xperfjit``. Patch by Pablo Galindo.

Python/initconfig.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1703,7 +1703,7 @@ config_init_perf_profiling(PyConfig *config)
17031703
if (xoption) {
17041704
config->perf_profiling = 1;
17051705
}
1706-
env = config_get_env(config, "PYTHONPERFJITSUPPORT");
1706+
env = config_get_env(config, "PYTHON_PERF_JIT_SUPPORT");
17071707
if (env) {
17081708
if (_Py_str_to_int(env, &active) != 0) {
17091709
active = 0;

0 commit comments

Comments
 (0)