diff options
author | Pablo Galindo Salgado <Pablogsal@gmail.com> | 2024-09-27 23:50:16 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-09-27 23:50:16 (GMT) |
commit | 02b49c51501f5eeef3ab5d74fb9eace1151a1359 (patch) | |
tree | d5e9c36d612b2023eeae9089372937c4334eb063 /Doc | |
parent | 425587a110eb214a097c634d4b6d944ac478923e (diff) | |
download | cpython-02b49c51501f5eeef3ab5d74fb9eace1151a1359.zip cpython-02b49c51501f5eeef3ab5d74fb9eace1151a1359.tar.gz cpython-02b49c51501f5eeef3ab5d74fb9eace1151a1359.tar.bz2 |
gh-107954: Fix configuration type for the perf profiler (#124636)
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/c-api/init_config.rst | 21 |
1 files changed, 13 insertions, 8 deletions
diff --git a/Doc/c-api/init_config.rst b/Doc/c-api/init_config.rst index 0ef7d01..9dc9ba6 100644 --- a/Doc/c-api/init_config.rst +++ b/Doc/c-api/init_config.rst @@ -1248,19 +1248,24 @@ PyConfig .. c:member:: int perf_profiling - Enable compatibility mode with the perf profiler? + Enable the Linux ``perf`` profiler support? - If non-zero, initialize the perf trampoline. See :ref:`perf_profiling` - for more information. + If equals to ``1``, enable support for the Linux ``perf`` profiler. - Set by :option:`-X perf <-X>` command-line option and by the - :envvar:`PYTHON_PERF_JIT_SUPPORT` environment variable for perf support - with stack pointers and :option:`-X perf_jit <-X>` command-line option - and by the :envvar:`PYTHON_PERF_JIT_SUPPORT` environment variable for perf - support with DWARF JIT information. + If equals to ``2``, enable support for the Linux ``perf`` profiler with + DWARF JIT support. + + Set to ``1`` by :option:`-X perf <-X>` command-line option and the + :envvar:`PYTHONPERFSUPPORT` environment variable. + + Set to ``2`` by the :option:`-X perf_jit <-X>` command-line option and + the :envvar:`PYTHON_PERF_JIT_SUPPORT` environment variable. Default: ``-1``. + .. seealso:: + See :ref:`perf_profiling` for more information. + .. versionadded:: 3.12 .. c:member:: int use_environment |