From e6c951f083cb8f57c55d35ed94d9ca3741194279 Mon Sep 17 00:00:00 2001 From: mpage Date: Tue, 24 Jun 2025 10:02:50 -0700 Subject: [PATCH] gh-135805: Document the X option and env var for controlling thread-local bytecode (GH-135868) Document the X option and env var for controlling thread-local bytecode. (cherry picked from commit fea5ccc55d8486300beb1d0254da030a4da10394) Co-authored-by: mpage --- Doc/using/cmdline.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/Doc/using/cmdline.rst b/Doc/using/cmdline.rst index 40a46a62031ef7..a5867b489e0053 100644 --- a/Doc/using/cmdline.rst +++ b/Doc/using/cmdline.rst @@ -669,6 +669,13 @@ Miscellaneous options .. versionadded:: 3.14 + * :samp:`-X tlbc={0,1}` enables (1, the default) or disables (0) thread-local + bytecode in builds configured with :option:`--disable-gil`. When disabled, + this also disables the specializing interpreter. See also + :envvar:`PYTHON_TLBC`. + + .. versionadded:: 3.14 + It also allows passing arbitrary values and retrieving them through the :data:`sys._xoptions` dictionary. @@ -1302,6 +1309,16 @@ conflict. .. versionadded:: 3.13 +.. envvar:: PYTHON_TLBC + + If set to ``1`` enables thread-local bytecode. If set to ``0`` thread-local + bytecode and the specializing interpreter are disabled. Only applies to + builds configured with :option:`--disable-gil`. + + See also the :option:`-X tlbc <-X>` command-line option. + + .. versionadded:: 3.14 + Debug-mode variables ~~~~~~~~~~~~~~~~~~~~