]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] gh-129438: Update ``--enable-experimental-jit`` section with install requireme...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Thu, 30 Jan 2025 10:22:05 +0000 (11:22 +0100)
committerGitHub <noreply@github.com>
Thu, 30 Jan 2025 10:22:05 +0000 (10:22 +0000)
gh-129438: Update ``--enable-experimental-jit`` section with install requirements (GH-129450)

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

(cherry picked from commit 652f66ac386dad5992c6f7c494871907272503f8)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
Doc/using/configure.rst
Tools/jit/README.md

index bf980b514ccd96de832b2f572588125d0a52cbe6..1a1f8ae02df0c00a2cef6254368d44970a247da4 100644 (file)
@@ -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
index bc6f793b296f1290fd6a9f48b818b2f7dd8bb30f..42d4fcd48e6b41b703fb005a7a184c6e12a76c71 100644 (file)
@@ -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).
@@ -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).