mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-13 21:38:57 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

[3.12] gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003) (#115135)

Browse source 
gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003)
(cherry picked from commit d0322fdf2c)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
This commit is contained in:
Miss Islington (bot) 2024-02-07 11:55:21 +01:00 • committed by GitHub
parent 060c3edc4b
commit a69e68db60
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/c-api/intro.rst
View file

@ -148,7 +148,7 @@ complete listing.
worse performances (due to increased code size for example). The compiler is worse performances (due to increased code size for example). The compiler is
usually smarter than the developer for the cost/benefit analysis. usually smarter than the developer for the cost/benefit analysis.
If Python is :ref:`built in debug mode <debug-build>` (if the ``Py_DEBUG`` If Python is :ref:`built in debug mode <debug-build>` (if the :c:macro:`Py_DEBUG`
macro is defined), the :c:macro:`Py_ALWAYS_INLINE` macro does nothing. macro is defined), the :c:macro:`Py_ALWAYS_INLINE` macro does nothing.
It must be specified before the function return type. Usage:: It must be specified before the function return type. Usage::
@ -812,12 +812,14 @@ available that support tracing of reference counts, debugging the memory
allocator, or low-level profiling of the main interpreter loop. Only the most allocator, or low-level profiling of the main interpreter loop. Only the most
frequently used builds will be described in the remainder of this section. frequently used builds will be described in the remainder of this section.
Compiling the interpreter with the :c:macro:`Py_DEBUG` macro defined produces .. c:macro:: Py_DEBUG
Compiling the interpreter with the :c:macro:`!Py_DEBUG` macro defined produces
what is generally meant by :ref:`a debug build of Python <debug-build>`. what is generally meant by :ref:`a debug build of Python <debug-build>`.
:c:macro:`Py_DEBUG` is enabled in the Unix build by adding :c:macro:`!Py_DEBUG` is enabled in the Unix build by adding
:option:`--with-pydebug` to the :file:`./configure` command. :option:`--with-pydebug` to the :file:`./configure` command.
It is also implied by the presence of the It is also implied by the presence of the
not-Python-specific :c:macro:`_DEBUG` macro. When :c:macro:`Py_DEBUG` is enabled not-Python-specific :c:macro:`!_DEBUG` macro. When :c:macro:`!Py_DEBUG` is enabled
in the Unix build, compiler optimization is disabled. in the Unix build, compiler optimization is disabled.
In addition to the reference count debugging described below, extra checks are In addition to the reference count debugging described below, extra checks are
@ -832,4 +834,3 @@ after every statement run by the interpreter.)
Please refer to :file:`Misc/SpecialBuilds.txt` in the Python source distribution Please refer to :file:`Misc/SpecialBuilds.txt` in the Python source distribution
for more detailed information. for more detailed information.

6
Doc/library/test.rst
View file

@ -324,9 +324,9 @@ The :mod:`test.support` module defines the following constants:
.. data:: Py_DEBUG .. data:: Py_DEBUG
True if Python is built with the :c:macro:`Py_DEBUG` macro defined: if True if Python was built with the :c:macro:`Py_DEBUG` macro
Python is :ref:`built in debug mode <debug-build>` defined, that is, if
(:option:`./configure --with-pydebug <--with-pydebug>`). Python was :ref:`built in debug mode <debug-build>`.
.. versionadded:: 3.12 .. versionadded:: 3.12