Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Docs: Add central references to free-threading-related options (#119017)

This commit is contained in:
Brett Simmers 2024-05-21 17:49:23 -04:00 committed by GitHub
parent 6e9863d7a3
commit 9fa206aaec
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Doc/c-api/module.rst
View File

@ -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.

5
Doc/using/cmdline.rst
View File

@ -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.

2
Doc/using/configure.rst
View File

@ -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

3
Doc/whatsnew/3.13.rst
View File

@ -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.