https://github.com/python/cpython/commit/9fa206aaeccc979a4bd03852ba38c045294a3d6f
commit: 9fa206aaeccc979a4bd03852ba38c045294a3d6f
branch: main
author: Brett Simmers <[email protected]>
committer: colesbury <[email protected]>
date: 2024-05-21T17:49:23-04:00
summary:
Docs: Add central references to free-threading-related options (#119017)
files:
M Doc/c-api/module.rst
M Doc/using/cmdline.rst
M Doc/using/configure.rst
M Doc/whatsnew/3.13.rst
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst
index 6fe1ce9e994832..63e3bed6727987 100644
--- a/Doc/c-api/module.rst
+++ b/Doc/c-api/module.rst
@@ -427,14 +427,14 @@ The available slot types are:
This slot is ignored by Python builds not configured with
:option:`--disable-gil`. Otherwise, it determines whether or not importing
this module will cause the GIL to be automatically enabled. See
- :envvar:`PYTHON_GIL` and :option:`-X gil <-X>` for more detail.
+ :ref:`free-threaded-cpython` for more detail.
Multiple ``Py_mod_gil`` slots may not be specified in one module definition.
If ``Py_mod_gil`` is not specified, the import machinery defaults to
``Py_MOD_GIL_USED``.
- .. versionadded: 3.13
+ .. versionadded:: 3.13
See :PEP:`489` for more details on multi-phase initialization.
diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst
index dcca9060899a0f..7b2019625eb27a 100644
--- a/Doc/using/cmdline.rst
+++ b/Doc/using/cmdline.rst
@@ -622,7 +622,8 @@ Miscellaneous options
* :samp:`-X gil={0,1}` forces the GIL to be disabled or enabled,
respectively. Only available in builds configured with
- :option:`--disable-gil`. See also :envvar:`PYTHON_GIL`.
+ :option:`--disable-gil`. See also :envvar:`PYTHON_GIL` and
+ :ref:`free-threaded-cpython`.
.. versionadded:: 3.13
@@ -1212,7 +1213,7 @@ conflict.
forced on. Setting it to ``0`` forces the GIL off.
See also the :option:`-X gil <-X>` command-line option, which takes
- precedence over this variable.
+ precedence over this variable, and :ref:`free-threaded-cpython`.
Needs Python configured with the :option:`--disable-gil` build option.
diff --git a/Doc/using/configure.rst b/Doc/using/configure.rst
index d30356d2058eff..428ee5275276a0 100644
--- a/Doc/using/configure.rst
+++ b/Doc/using/configure.rst
@@ -299,7 +299,7 @@ General Options
Defines the ``Py_GIL_DISABLED`` macro and adds ``"t"`` to
:data:`sys.abiflags`.
- See :pep:`703` "Making the Global Interpreter Lock Optional in CPython".
+ See :ref:`free-threaded-cpython` for more detail.
.. versionadded:: 3.13
diff --git a/Doc/whatsnew/3.13.rst b/Doc/whatsnew/3.13.rst
index 8cd174f01ff600..7edfdd4f8167a0 100644
--- a/Doc/whatsnew/3.13.rst
+++ b/Doc/whatsnew/3.13.rst
@@ -368,7 +368,8 @@ CPython will run with the :term:`global interpreter lock`
(GIL) disabled when
configured using the ``--disable-gil`` option at build time. This is an
experimental feature and therefore isn't used by default. Users need to
either compile their own interpreter, or install one of the experimental
-builds that are marked as *free-threaded*.
+builds that are marked as *free-threaded*. See :pep:`703` "Making the Global
+Interpreter Lock Optional in CPython" for more detail.
Free-threaded execution allows for full utilization of the available
processing power by running threads in parallel on available CPU cores.
_______________________________________________
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]
