Skip to content

Commit

Permalink
[3.13] pythongh-129438: Update --enable-experimental-jit section …
Browse files Browse the repository at this point in the history
…with install requirements (pythonGH-129450) (python#129472)

pythongh-129438: Update ``--enable-experimental-jit`` section with install requirements (pythonGH-129450)

Add a note to the `JIT` docs that building CPython with `JIT` requires Python 3.11 or newer.

(cherry picked from commit 652f66a)

Co-authored-by: Stan Ulbrych <[email protected]>
Co-authored-by: Brandt Bucher <[email protected]>
  • Loading branch information
3 people authored Jan 30, 2025
1 parent ad4a141 commit fcb2656
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
4 changes: 4 additions & 0 deletions Doc/using/configure.rst
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,10 @@ General Options

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

.. note::

When building CPython with JIT enabled, ensure that your system has Python 3.11 or later installed.

.. versionadded:: 3.13

.. option:: PKG_CONFIG
Expand Down
4 changes: 3 additions & 1 deletion Tools/jit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ The JIT Compiler

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.

Python 3.11 or newer is required to build the JIT.

## Installing LLVM

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).
Expand Down Expand Up @@ -57,7 +59,7 @@ For `PCbuild`-based builds, pass the new `--experimental-jit` option to `build.b

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

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

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).

Expand Down

0 comments on commit fcb2656

Please sign in to comment.