Skip to content

Commit 2830252

Browse files
canovahugovk
andauthored
Apply documentation suggestions from code review
Co-authored-by: Hugo van Kemenade <[email protected]>
1 parent 8b03dc1 commit 2830252

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

Doc/c-api/perfmaps.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Support for Perf Maps
66
----------------------
77

8-
On supported platforms (as of this writing, Linux and macOS), the runtime can take
8+
On supported platforms (Linux and macOS), the runtime can take
99
advantage of *perf map files* to make Python functions visible to an external
1010
profiling tool (such as `perf <https://perf.wiki.kernel.org/index.php/Main_Page>`_ or
1111
`samply <https://github.com/mstange/samply/>`_). A running process may create a

Doc/howto/perf_profiling.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ relationship between this piece of code and the associated Python function using
2828
.. note::
2929

3030
Support for profiling is available on Linux and macOS on select architectures.
31-
``perf`` is available on Linux, while ``samply`` can be used on both Linux and macOS.
32-
``samply`` support on macOS is available starting from Python 3.14.
31+
Perf is available on Linux, while samply can be used on both Linux and macOS.
32+
samply support on macOS is available starting from Python 3.14.
3333
Check the output of the ``configure`` build step or
3434
check the output of ``python -m sysconfig | grep HAVE_PERF_TRAMPOLINE``
3535
to see if your system is supported.
@@ -149,25 +149,25 @@ Instead, if we run the same experiment with ``perf`` support enabled we get:
149149
150150
151151
152-
Using ``samply`` profiler
152+
Using the samply profiler
153153
-------------------------
154154

155-
``samply`` is a modern profiler that can be used as an alternative to ``perf``.
155+
samply is a modern profiler that can be used as an alternative to perf.
156156
It uses the same perf map files that Python generates, making it compatible
157-
with Python's profiling support. ``samply`` is particularly useful on macOS
158-
where ``perf`` is not available.
157+
with Python's profiling support. samply is particularly useful on macOS
158+
where perf is not available.
159159

160-
To use ``samply`` with Python, first install it following the instructions at
160+
To use samply with Python, first install it following the instructions at
161161
https://github.com/mstange/samply, then run::
162162

163163
$ samply record PYTHONPERFSUPPORT=1 python my_script.py
164164

165165
This will open a web interface where you can analyze the profiling data
166-
interactively. The advantage of ``samply`` is that it provides a modern
166+
interactively. The advantage of samply is that it provides a modern
167167
web-based interface for analyzing profiling data and works on both Linux
168168
and macOS.
169169

170-
On macOS, ``samply`` support requires Python 3.14 or later.
170+
On macOS, samply support requires Python 3.14 or later.
171171

172172
How to enable ``perf`` profiling support
173173
----------------------------------------
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
Add support for perf trampoline on macOS, to allow profilers wit JIT map
2-
support to read python calls. While profiling, ``PYTHONPERFSUPPORT=1`` can
2+
support to read Python calls. While profiling, ``PYTHONPERFSUPPORT=1`` can
33
be appended to enable the trampoline.

0 commit comments

Comments
 (0)