https://github.com/python/cpython/commit/d0322fdf2c1a7292a43959fe5a572d783b88a1c4
commit: d0322fdf2c1a7292a43959fe5a572d783b88a1c4
branch: main
author: Skip Montanaro <[email protected]>
committer: AlexWaygood <[email protected]>
date: 2024-02-07T10:48:42Z
summary:
gh-101100: Fix Py_DEBUG dangling Sphinx references (#115003)
files:
M Doc/c-api/intro.rst
M Doc/library/test.rst
diff --git a/Doc/c-api/intro.rst b/Doc/c-api/intro.rst
index 4dbca92b18b5cd..dcda1071a58f35 100644
--- a/Doc/c-api/intro.rst
+++ b/Doc/c-api/intro.rst
@@ -148,7 +148,7 @@ complete listing.
worse performances (due to increased code size for example). The compiler is
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.
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
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>`.
-: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.
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 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
for more detailed information.
-
diff --git a/Doc/library/test.rst b/Doc/library/test.rst
index cad1023021a512..7d28f625345726 100644
--- a/Doc/library/test.rst
+++ b/Doc/library/test.rst
@@ -324,9 +324,9 @@ The :mod:`test.support` module defines the following
constants:
.. data:: Py_DEBUG
- True if Python is built with the :c:macro:`Py_DEBUG` macro defined: if
- Python is :ref:`built in debug mode <debug-build>`
- (:option:`./configure --with-pydebug <--with-pydebug>`).
+ True if Python was built with the :c:macro:`Py_DEBUG` macro
+ defined, that is, if
+ Python was :ref:`built in debug mode <debug-build>`.
.. versionadded:: 3.12
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
