mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-12-10 02:50:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858)

Browse source 
Use generic '.. object::' to declare markers, rather than abusing
'..  c:function::' which fails on Sphinx 3.
This commit is contained in:
Victor Stinner 2020-08-13 19:15:38 +02:00 • committed by GitHub
parent e087f7cd43
commit 43577c01a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

24
Doc/howto/instrumentation.rst
View file

@ -272,9 +272,7 @@ should instead read:
Available static markers Available static markers
------------------------ ------------------------
.. I'm reusing the "c:function" type for markers .. object:: function__entry(str filename, str funcname, int lineno)
.. c:function:: function__entry(str filename, str funcname, int lineno)
This marker indicates that execution of a Python function has begun. This marker indicates that execution of a Python function has begun.
It is only triggered for pure-Python (bytecode) functions. It is only triggered for pure-Python (bytecode) functions.
@ -290,7 +288,7 @@ Available static markers
* ``$arg3`` : ``int`` line number * ``$arg3`` : ``int`` line number
.. c:function:: function__return(str filename, str funcname, int lineno) .. object:: function__return(str filename, str funcname, int lineno)
This marker is the converse of :c:func:`function__entry`, and indicates that This marker is the converse of :c:func:`function__entry`, and indicates that
execution of a Python function has ended (either via ``return``, or via an execution of a Python function has ended (either via ``return``, or via an
@ -298,7 +296,7 @@ Available static markers
The arguments are the same as for :c:func:`function__entry` The arguments are the same as for :c:func:`function__entry`
.. c:function:: line(str filename, str funcname, int lineno) .. object:: line(str filename, str funcname, int lineno)
This marker indicates a Python line is about to be executed. It is This marker indicates a Python line is about to be executed. It is
the equivalent of line-by-line tracing with a Python profiler. It is the equivalent of line-by-line tracing with a Python profiler. It is
@ -306,24 +304,24 @@ Available static markers
The arguments are the same as for :c:func:`function__entry`. The arguments are the same as for :c:func:`function__entry`.
.. c:function:: gc__start(int generation) .. object:: gc__start(int generation)
Fires when the Python interpreter starts a garbage collection cycle. Fires when the Python interpreter starts a garbage collection cycle.
``arg0`` is the generation to scan, like :func:`gc.collect()`. ``arg0`` is the generation to scan, like :func:`gc.collect()`.
.. c:function:: gc__done(long collected) .. object:: gc__done(long collected)
Fires when the Python interpreter finishes a garbage collection Fires when the Python interpreter finishes a garbage collection
cycle. ``arg0`` is the number of collected objects. cycle. ``arg0`` is the number of collected objects.
.. c:function:: import__find__load__start(str modulename) .. object:: import__find__load__start(str modulename)
Fires before :mod:`importlib` attempts to find and load the module. Fires before :mod:`importlib` attempts to find and load the module.
``arg0`` is the module name. ``arg0`` is the module name.
.. versionadded:: 3.7 .. versionadded:: 3.7
.. c:function:: import__find__load__done(str modulename, int found) .. object:: import__find__load__done(str modulename, int found)
Fires after :mod:`importlib`'s find_and_load function is called. Fires after :mod:`importlib`'s find_and_load function is called.
``arg0`` is the module name, ``arg1`` indicates if module was ``arg0`` is the module name, ``arg1`` indicates if module was
@ -332,7 +330,7 @@ Available static markers
.. versionadded:: 3.7 .. versionadded:: 3.7
.. c:function:: audit(str event, void *tuple) .. object:: audit(str event, void *tuple)
Fires when :func:`sys.audit` or :c:func:`PySys_Audit` is called. Fires when :func:`sys.audit` or :c:func:`PySys_Audit` is called.
``arg0`` is the event name as C string, ``arg1`` is a :c:type:`PyObject` ``arg0`` is the event name as C string, ``arg1`` is a :c:type:`PyObject`
@ -375,14 +373,14 @@ If this file is installed in SystemTap's tapset directory (e.g.
``/usr/share/systemtap/tapset``), then these additional probepoints become ``/usr/share/systemtap/tapset``), then these additional probepoints become
available: available:
.. c:function:: python.function.entry(str filename, str funcname, int lineno, frameptr) .. object:: python.function.entry(str filename, str funcname, int lineno, frameptr)
This probe point indicates that execution of a Python function has begun. This probe point indicates that execution of a Python function has begun.
It is only triggered for pure-Python (bytecode) functions. It is only triggered for pure-Python (bytecode) functions.
.. c:function:: python.function.return(str filename, str funcname, int lineno, frameptr) .. object:: python.function.return(str filename, str funcname, int lineno, frameptr)
This probe point is the converse of :c:func:`python.function.return`, and This probe point is the converse of ``python.function.return``, and
indicates that execution of a Python function has ended (either via indicates that execution of a Python function has ended (either via
``return``, or via an exception). It is only triggered for pure-Python ``return``, or via an exception). It is only triggered for pure-Python
(bytecode) functions. (bytecode) functions.