Skip to content

Commit 50d27e1

Browse files
committed
update docs
1 parent faa85f5 commit 50d27e1

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

Doc/howto/perf_profiling.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,8 @@ functions to appear in the output of the ``perf`` profiler. When this mode is
2424
enabled, the interpreter will interpose a small piece of code compiled on the
2525
fly before the execution of every Python function and it will teach ``perf`` the
2626
relationship between this piece of code and the associated Python function using
27-
`perf map files`_.
27+
`perf map files`_. If you're an extension author interested in having your extension
28+
write to the perf map files, refer to :doc:`the C-API <../c-api/perfmaps.rst>`.
2829

2930
.. note::
3031

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
Introduced :c:func:`PyUnstable_WritePerfMapEntry`, :c:func:`PyUnstable_PerfMapState_Init` and
22
:c:func:`PyUnstable_PerfMapState_Fini`. These allow extension modules (JIT compilers in
3-
particular) to write to perf-map files in a thread safe manner.
3+
particular) to write to perf-map files in a thread safe manner. The
4+
:doc:`perf profiling feature <../howto/perf_profiling.rst>` also uses these APIs to write
5+
entries in the perf-map file.

0 commit comments

Comments
 (0)