Skip to content

Commit 652f66a

Browse files
gh-129438: Update --enable-experimental-jit section with install requirements (#129450)
Add a note to the `JIT` docs that building CPython with `JIT` requires Python 3.11 or newer. Co-authored-by: Brandt Bucher <[email protected]>
1 parent 9bc8c5f commit 652f66a

File tree

2 files changed

+7
-1
lines changed

2 files changed

+7
-1
lines changed

Doc/using/configure.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -311,6 +311,10 @@ General Options
311311

312312
By convention, ``--enable-experimental-jit`` is a shorthand for ``--enable-experimental-jit=yes``.
313313

314+
.. note::
315+
316+
When building CPython with JIT enabled, ensure that your system has Python 3.11 or later installed.
317+
314318
.. versionadded:: 3.13
315319

316320
.. option:: PKG_CONFIG

Tools/jit/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ The JIT Compiler
33

44
This version of CPython can be built with an experimental just-in-time compiler[^pep-744]. While most everything you already know about building and using CPython is unchanged, you will probably need to install a compatible version of LLVM first.
55

6+
Python 3.11 or newer is required to build the JIT.
7+
68
## Installing LLVM
79

810
The JIT compiler does not require end users to install any third-party dependencies, but part of it must be *built* using LLVM[^why-llvm]. You are *not* required to build the rest of CPython using LLVM, or even the same version of LLVM (in fact, this is uncommon).
@@ -54,7 +56,7 @@ For `PCbuild`-based builds, pass the new `--experimental-jit` option to `build.b
5456

5557
For all other builds, pass the new `--enable-experimental-jit` option to `configure`.
5658

57-
Otherwise, just configure and build as you normally would. Cross-compiling "just works", since the JIT is built for the host platform.
59+
Otherwise, just configure and build as you normally would. Cross-compiling "just works", since the JIT is built for the host platform.
5860

5961
The JIT can also be enabled or disabled using the `PYTHON_JIT` environment variable, even on builds where it is enabled or disabled by default. More details about configuring CPython with the JIT and optional values for `--enable-experimental-jit` can be found [here](https://docs.python.org/dev/whatsnew/3.13.html#experimental-jit-compiler).
6062

0 commit comments

Comments
 (0)