Skip to content

Commit 9fa206a

Browse files
authored
Docs: Add central references to free-threading-related options (#119017)
1 parent 6e9863d commit 9fa206a

File tree

4 files changed

+8
-6
lines changed

4 files changed

+8
-6
lines changed

Diff for: Doc/c-api/module.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -427,14 +427,14 @@ The available slot types are:
427427
This slot is ignored by Python builds not configured with
428428
:option:`--disable-gil`. Otherwise, it determines whether or not importing
429429
this module will cause the GIL to be automatically enabled. See
430-
:envvar:`PYTHON_GIL` and :option:`-X gil <-X>` for more detail.
430+
:ref:`free-threaded-cpython` for more detail.
431431
432432
Multiple ``Py_mod_gil`` slots may not be specified in one module definition.
433433
434434
If ``Py_mod_gil`` is not specified, the import machinery defaults to
435435
``Py_MOD_GIL_USED``.
436436
437-
.. versionadded: 3.13
437+
.. versionadded:: 3.13
438438
439439
See :PEP:`489` for more details on multi-phase initialization.
440440

Diff for: Doc/using/cmdline.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -622,7 +622,8 @@ Miscellaneous options
622622

623623
* :samp:`-X gil={0,1}` forces the GIL to be disabled or enabled,
624624
respectively. Only available in builds configured with
625-
:option:`--disable-gil`. See also :envvar:`PYTHON_GIL`.
625+
:option:`--disable-gil`. See also :envvar:`PYTHON_GIL` and
626+
:ref:`free-threaded-cpython`.
626627

627628
.. versionadded:: 3.13
628629

@@ -1212,7 +1213,7 @@ conflict.
12121213
forced on. Setting it to ``0`` forces the GIL off.
12131214

12141215
See also the :option:`-X gil <-X>` command-line option, which takes
1215-
precedence over this variable.
1216+
precedence over this variable, and :ref:`free-threaded-cpython`.
12161217

12171218
Needs Python configured with the :option:`--disable-gil` build option.
12181219

Diff for: Doc/using/configure.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -299,7 +299,7 @@ General Options
299299
Defines the ``Py_GIL_DISABLED`` macro and adds ``"t"`` to
300300
:data:`sys.abiflags`.
301301

302-
See :pep:`703` "Making the Global Interpreter Lock Optional in CPython".
302+
See :ref:`free-threaded-cpython` for more detail.
303303

304304
.. versionadded:: 3.13
305305

Diff for: Doc/whatsnew/3.13.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,8 @@ CPython will run with the :term:`global interpreter lock` (GIL) disabled when
368368
configured using the ``--disable-gil`` option at build time. This is an
369369
experimental feature and therefore isn't used by default. Users need to
370370
either compile their own interpreter, or install one of the experimental
371-
builds that are marked as *free-threaded*.
371+
builds that are marked as *free-threaded*. See :pep:`703` "Making the Global
372+
Interpreter Lock Optional in CPython" for more detail.
372373

373374
Free-threaded execution allows for full utilization of the available
374375
processing power by running threads in parallel on available CPU cores.

0 commit comments

Comments
 (0)