Add blurb about NewParallel default to RELEASE.txt
[scons.git] / RELEASE.txt
blob71dcd8f1c954382826ee60dba9eb7c00f0b2628b
1 If you are reading this in the git repository, the contents
2 refer to *unreleased* changes since the last SCons release.
3 Past official release announcements appear at:
5     https://scons.org/tag/releases.html
7 ==================================================================
9 A new SCons release, 4.6.1, is now available on the SCons download page:
11     https://scons.org/pages/download.html
14 Here is a summary of the changes since 4.6.0:
16 NEW FUNCTIONALITY
17 -----------------
19 - Method unlink_files was added to the TestCmd class that unlinks a list of files
20   from a specified directory.  An attempt to unlink a file is made only when the
21   file exists; otherwise, the file is ignored.
24 DEPRECATED FUNCTIONALITY
25 ------------------------
27 - List anything that's been deprecated since the last release
29 CHANGED/ENHANCED EXISTING FUNCTIONALITY
30 ---------------------------------------
32 - Add an optional argument list string to configure's CheckFunc method so
33   that the generated function argument list matches the function's
34   prototype when including a header file. Fixes GH Issue #4320
35 - Now supports pre-release Python 3.13
36 - Support for Python versions without support for the `threading` package has been removed
38 FIXES
39 -----
41 - Fix of the --debug=sconscript option to return exist statements when using return
42   statement with stop flag enabled
43 - MSVS: prevent overwriting the SCons environment variable SCONS_HOME with the OS
44   environment value of SCONS_HOME in the msvs tool.
45 - MSVC: Fix the detection of Visual Studio 2015 Express ('14.0Exp') by adding a
46   registry key definition and updating the installation root-relative registry value
47   at runtime for the location of the VC folder.
48 - MSVS: Fix the msvs project generation test for MSVS 6.0 to use the correct name of
49   the generated project file.
50 - MSVS: Fix the msvs project generation test scripts so that "false positive" tests
51   results are not possible when the initial build is successful and the command-line
52   build of the project file fails.
54 IMPROVEMENTS
55 ------------
57 - Use of NotImplemented instead of NotImplementedError for special methods
58   of _ListVariable class
59 - The NewParallel scheduler is now the default, the `tm_v2` flag is removed,
60   and the old scheduler is opt-in under `--experimental=legacy_sched`. Additionally,
61   the new scheduler is now used for -j1 builds as well.
62   NOTE: This should significantly improve SCons performance for larger parallel builds
63         (Larger -j values)
66 PACKAGING
67 ---------
69 - Remove unecessary dependencies on pypi packages from setup.cfg
71 DOCUMENTATION
72 -------------
74 - List any significant changes to the documentation (not individual
75   typo fixes, even if they're mentioned in src/CHANGES.txt to give
76   the contributor credit)
78 DEVELOPMENT
79 -----------
81 - Fix sphinx config to handle SCons versions with post such as: 4.6.0.post1
83 Thanks to the following contributors listed below for their contributions to this release.
84 ==========================================================================================
85 .. code-block:: text
87     git shortlog --no-merges -ns 4.6.0..HEAD