diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2024-05-21 23:16:59 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-21 23:16:59 (GMT) |
| commit | 05820164cecdd377474ebcf3a69eaefac27fc329 (patch) | |
| tree | 78f5ef7b2a381f80f764189d5c66870dfdcc6567 | |
| parent | fef202f97b096787f5638eb3adb96366d7b66887 (diff) | |
| download | cpython-05820164cecdd377474ebcf3a69eaefac27fc329.zip cpython-05820164cecdd377474ebcf3a69eaefac27fc329.tar.gz cpython-05820164cecdd377474ebcf3a69eaefac27fc329.tar.bz2 | |
[3.13] Docs: Add central references to free-threading-related options (GH-119017) (#119367)
Docs: Add central references to free-threading-related options (GH-119017)
(cherry picked from commit 9fa206aaeccc979a4bd03852ba38c045294a3d6f)
Co-authored-by: Brett Simmers <swtaarrs@users.noreply.github.com>
| -rw-r--r-- | Doc/c-api/module.rst | 4 | ||||
| -rw-r--r-- | Doc/using/cmdline.rst | 5 | ||||
| -rw-r--r-- | Doc/using/configure.rst | 2 | ||||
| -rw-r--r-- | Doc/whatsnew/3.13.rst | 3 |
4 files changed, 8 insertions, 6 deletions
diff --git a/Doc/c-api/module.rst b/Doc/c-api/module.rst index 6fe1ce9..63e3bed 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 2d95fa9..0620f7d 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -616,7 +616,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 @@ -1206,7 +1207,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 d30356d..428ee52 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 339391f..9fcead9 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. |