Skip to content

Commit

Permalink
Add central references to free-threading-related options
Browse files Browse the repository at this point in the history
  • Loading branch information
swtaarrs committed May 13, 2024
1 parent b04c497 commit 43a0642
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 5 deletions.
4 changes: 2 additions & 2 deletions Doc/c-api/module.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
5 changes: 3 additions & 2 deletions Doc/using/cmdline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.

Expand Down
3 changes: 2 additions & 1 deletion Doc/using/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,8 @@ 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 :pep:`703` "Making the Global Interpreter Lock Optional in CPython" and
:ref:`free-threaded-cpython`.

.. versionadded:: 3.13

Expand Down

0 comments on commit 43a0642

Please sign in to comment.