Implement `GetSConsVersion` static method
[scons.git] / RELEASE.txt
blob650288043f57c5d0b7169fd40ccee67504ff7616
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.7.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.7.0:
16 NEW FUNCTIONALITY
17 -----------------
19 - GetSConsVersion() to grab the current SCons version from an exposed api.
21 DEPRECATED FUNCTIONALITY
22 ------------------------
24 - List anything that's been deprecated since the last release
26 CHANGED/ENHANCED EXISTING FUNCTIONALITY
27 ---------------------------------------
29 - Dump() with json format selected now recognizes additional compound types
30   (UserDict and UserList), which improves the detail of the display.
31   json output is also sorted, to match the default display.
32 - Python 3.13 changes the behavior of isabs() on Windows. Adjust SCons
33   usage of this in NodeInfo classes to avoid test problems.
34 - Drop duplicated __getstate__ and __setstate__ methods in AliasNodeInfo,
35   FileNodeInfo and ValueNodeInfo classes, as they are identical to the
36   ones in parent NodeInfoBase and can just be inherited.
37 - All exceptions during the execution of an Action are now returned by value
38   rather than by raising an exception, for more consistent behavior.
39   NOTE: With this change, user created Actions should now catch and handle
40   expected exceptions (whereas previously many of these were silently caught
41   and suppressed by the SCons Action exection code).
43 FIXES
44 -----
46 - OSErrors are now no longer hidden during the execution of Actions.
48 IMPROVEMENTS
49 ------------
51 - List improvements that wouldn't be visible to the user in the
52   documentation:  performance improvements (describe the circumstances
53   under which they would be observed), or major code cleanups
55 PACKAGING
56 ---------
58 - List changes in the way SCons is packaged and/or released
61 DOCUMENTATION
62 -------------
64 - Updated Value Node docs.
65 - Update manpage for Tools, and for the TOOL variable.
69 DEVELOPMENT
70 -----------
72 - Documentation build now properly passes through skipping the PDF
73   (and EPUB) builds of manpage and user guide; this can also be done
74   manually if directly calling doc/man/SConstruct and doc/user/SConstruct
75   by adding SKIP_PDF=1. This should help with distro packaging of SCons,
76   which now does not need "fop" and other tools to be set up in order to
77   build pdf versions which are then ignored.
80 Thanks to the following contributors listed below for their contributions to this release.
81 ==========================================================================================
82 .. code-block:: text
84     git shortlog --no-merges -ns 4.0.1..HEAD