[3.14] gh-131591: Document Py_REMOTE_DEBUG (GH-135929) (GH-136374)

gh-131591: Document Py_REMOTE_DEBUG (GH-135929)
(cherry picked from commit 9aac5a3d44d7191001660aed3a383b062ee4b29b)

Co-authored-by: Petr Viktorin <encukou@gmail.com>

diff --git a/Doc/using/configure.rst b/Doc/using/configure.rst
index a26d48d7d0a3451181410b849f39aa48fdddf042..e5fe3c72b1b26ea331ec4fa8a23fca51c2b6d5ff 100644 (file)
--- a/Doc/using/configure.rst
+++ b/Doc/using/configure.rst
@@ -686,6 +686,13 @@ also be used to improve performance.
    not compiled. This includes both the functionality to schedule code to be executed
    and the functionality to receive code to be executed.
 
+   .. c:macro:: Py_REMOTE_DEBUG
+
+      This macro is defined by default, unless Python is configured with
+      :option:`--without-remote-debug`.
+
+      Note that even if the macro is defined, remote debugging may not be
+      available (for example, on an incompatible platform).
 
    .. versionadded:: 3.14