Skip to content

Commit 59d97a7

Browse files
committed
Remove instructions on setting up Pyston for faster development
This is done for several reasons: - Recent CPython versions such as 3.13 have mostly caught up with Pyston in terms of performance. If the trend continues, CPython may supersede Pyston's performance in the long term. This is especially the case if the experimental JIT is eventually able to run Godot's SCons setup. - Pyston is not maintained anymore (its last release was in 2022), and the last Python version it can run is 3.8. Python 3.8 is now end-of-life. Godot's SCons setup (as well as SCons itself) will eventually require Python versions newer than 3.8.
1 parent 1a72210 commit 59d97a7

File tree

2 files changed

+2
-49
lines changed

2 files changed

+2
-49
lines changed

contributing/development/compiling/compiling_for_linuxbsd.rst

Lines changed: 1 addition & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -272,7 +272,7 @@ Start a terminal, go to the root dir of the engine source code and type:
272272

273273
.. tip::
274274
If you are compiling Godot to make changes or contribute to the engine,
275-
you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``.
275+
you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``.
276276
See :ref:`doc_introduction_to_the_buildsystem_development_and_production_aliases`
277277
for more info.
278278

@@ -601,34 +601,3 @@ running ``scons -h``, then looking for options starting with ``builtin_``.
601601
across Linux distributions anymore. Do not use this approach for creating
602602
binaries you intend to distribute to others, unless you're creating a
603603
package for a Linux distribution.
604-
605-
Using Pyston for faster development
606-
-----------------------------------
607-
608-
You can use `Pyston <https://www.pyston.org/>`__ to run SCons. Pyston is a JIT-enabled
609-
implementation of the Python language (which SCons is written in). It is currently
610-
only compatible with Linux. Pyston can speed up incremental builds significantly,
611-
often by a factor between 1.5× and 2×. Pyston can be combined with Clang and LLD
612-
to get even faster builds.
613-
614-
- Download the `latest portable Pyston release <https://github.com/pyston/pyston/releases/latest>`__.
615-
- Extract the portable ``.tar.gz`` to a set location, such as ``$HOME/.local/opt/pyston/`` (create folders as needed).
616-
- Use ``cd`` to reach the extracted Pyston folder from a terminal,
617-
then run ``./pyston -m pip install scons`` to install SCons within Pyston.
618-
- To make SCons via Pyston easier to run, create a symbolic link of its wrapper
619-
script to a location in your ``PATH`` environment variable::
620-
621-
ln -s ~/.local/opt/pyston/bin/scons ~/.local/bin/pyston-scons
622-
623-
- Instead of running ``scons <build arguments>``, run ``pyston-scons <build arguments>``
624-
to compile Godot.
625-
626-
If you can't run ``pyston-scons`` after creating the symbolic link,
627-
make sure ``$HOME/.local/bin/`` is part of your user's ``PATH`` environment variable.
628-
629-
.. note::
630-
631-
Alternatively, you can run ``python -m pip install pyston_lite_autoload``
632-
then run SCons as usual. This will automatically load a subset of Pyston's
633-
optimizations in any Python program you run. However, this won't bring as
634-
much of a performance improvement compared to installing "full" Pyston.

contributing/development/compiling/compiling_for_macos.rst

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ To support both architectures in a single "Universal 2" binary, run the above tw
6161

6262
.. tip::
6363
If you are compiling Godot to make changes or contribute to the engine,
64-
you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``.
64+
you may want to use the SCons options ``dev_build=yes`` or ``dev_mode=yes``.
6565
See :ref:`doc_introduction_to_the_buildsystem_development_and_production_aliases`
6666
for more info.
6767

@@ -166,22 +166,6 @@ template from the official Godot distribution::
166166

167167
zip -r9 macos.zip macos_template.app
168168

169-
Using Pyston for faster development
170-
-----------------------------------
171-
172-
You can use `Pyston <https://www.pyston.org/>`__ to run SCons. Pyston is a
173-
JIT-enabled implementation of the Python language (which SCons is written in).
174-
Its "full" version is currently only compatible with Linux, but Pyston-lite is
175-
also compatible with macOS (both x86 and ARM). Pyston can speed up incremental
176-
builds significantly, often by a factor between 1.5× and 2×. Pyston can be
177-
combined with alternative linkers such as LLD or Mold to get even faster builds.
178-
179-
To install Pyston-lite, run ``python -m pip install pyston_lite_autoload`` then
180-
run SCons as usual. This will automatically load a subset of Pyston's
181-
optimizations in any Python program you run. However, this won't bring as much
182-
of a performance improvement compared to installing "full" Pyston (which
183-
currently can't be done on macOS).
184-
185169
Cross-compiling for macOS from Linux
186170
------------------------------------
187171

0 commit comments

Comments
 (0)