RELEASE.txt

   1 A new SCons release, 4.7.0, is now available on the SCons download page:
   2
   3     https://scons.org/pages/download.html
   4
   5 Here is a summary of the changes since 4.6.0:
   6
   7 NEW FUNCTIONALITY
   8 -----------------
   9
  10 - Method unlink_files was added to the TestCmd class that unlinks a list of files
  11   from a specified directory.  An attempt to unlink a file is made only when the
  12   file exists; otherwise, the file is ignored.
  13
  14 CHANGED/ENHANCED EXISTING FUNCTIONALITY
  15 ---------------------------------------
  16
  17 - Add an optional argument list string to configure's CheckFunc method so
  18   that the generated function argument list matches the function's
  19   prototype when including a header file. Fixes GH Issue #4320
  20 - Now supports pre-release Python 3.13
  21 - Support for Python versions without support for the `threading` package has been removed
  22 - Dropped three unused warning classes: DeprecatedSourceCodeWarning,
  23   TaskmasterNeedsExecuteWarning, DeprecatedMissingSConscriptWarning.
  24 * Two warning classes that are actually used were added to manpage section on
  25   enabling warnings (cache-cleanup-error, future-reserved-variable).
  26
  27 FIXES
  28 -----
  29
  30 - Fix of the --debug=sconscript option to return exist statements when using return
  31   statement with stop flag enabled
  32 - MSVS: prevent overwriting the SCons environment variable SCONS_HOME with the OS
  33   environment value of SCONS_HOME in the msvs tool.
  34 - MSVC: Fix the detection of Visual Studio 2015 Express ('14.0Exp') by adding a
  35   registry key definition and updating the installation root-relative registry value
  36   at runtime for the location of the VC folder.
  37 - MSVS: Fix the msvs project generation test for MSVS 6.0 to use the correct name of
  38   the generated project file.
  39 - MSVS: Fix the msvs project generation test scripts so that "false positive" tests
  40   results are not possible when the initial build is successful and the command-line
  41   build of the project file fails.
  42 - On Windows platform, when collecting command output (Configure checks),
  43   make sure decoding of bytes doesn't fail.
  44 - Documentation indicated that both Pseudo() and env.Pseudo() were usable,
  45   but Pseudo() did not work; is now enabled.
  46 - Improve handling of file data that SCons itself processes - as in
  47   scanners - try harder to decode non-UTF-8 text.
  48 - PyPackageDir no longer fails if passed a module name which cannot be found,
  49   now returns None.
  50 - Add locking around creation of CacheDir config file. Fixes issue #4489.
  51
  52 IMPROVEMENTS
  53 ------------
  54
  55 - Use of NotImplemented instead of NotImplementedError for special methods
  56   of _ListVariable class
  57 - The NewParallel scheduler is now the default, the `tm_v2` flag is removed,
  58   and the old scheduler is opt-in under `--experimental=legacy_sched`. Additionally,
  59   the new scheduler is now used for -j1 builds as well.
  60   NOTE: This should significantly improve SCons performance for larger parallel builds
  61         (Larger -j values)
  62 - CacheDir writes no longer happen within the taskmaster critical section, and therefore
  63   can run in parallel with both other CacheDir writes and the taskmaster DAG walk.
  64 - The NewParallel scheduler now only adds threads as new work requiring execution
  65   is discovered, up to the limit set by -j. This should reduce resource utilization
  66   when the achievable parallelism in the DAG is less than the -j limit.
  67 - Dumping an environment with `json` formatting will now explicitly specify if a given
  68   value cannot be serialized.
  69
  70 PACKAGING
  71 ---------
  72
  73 - Remove unnecessary dependencies on pypi packages from setup.cfg
  74 - SCons documentation build can now be controlled through SKIP_DOC
  75   variable - rather than just true/false can now specify
  76   skip none, skip all, skip pdf docs, skip api docs.
  77
  78 DOCUMENTATION
  79 -------------
  80
  81 - Fixed the Scanner examples in the User Guide to be runnable and added
  82   some more explanation. Clarified discussion of the scanner function in
  83   the Scanner Objects section of the manpage.
  84 - The manpage entry for Pseudo was clarified.
  85 - The manpage entry for SharedLibrary was clarified.
  86 - Update API docs for Warnings framework; add two warns to manpage
  87   enable/disable control.
  88 - More consistent use of &Python; in the manpage.  A few links added.
  89   A warning about overwriting env['ENV'] and one about Configure
  90   checks possibly not running in in no-exec mode also added.
  91 - Clarify how SCons finds the project top directory, and what that is used for.
  92 - Clarify MergeFlags usage of a dict argument.
  93
  94 DEVELOPMENT
  95 -----------
  96
  97 - Fix sphinx config to handle SCons versions with post such as: 4.6.0.post1
  98 - Created SCons.Util.sctyping to contain complex type information, allowing
  99   for repo-wide type hinting without causing cyclical dependencies.
 100
 101 Thanks to the following contributors listed below for their contributions to this release.
 102 ==========================================================================================
 103 .. code-block:: text
 104
 105     git shortlog --no-merges -ns 4.6.0..HEAD
 106     26  Andrew Morrow
 107     24  Mats Wichmann
 108     14  William Deegan
 109      7  Joseph Brill
 110      6  StenGruener
 111      3  Prabhu S. Khalsa
 112      3  Thaddeus Crews
 113      2  fazledyn-or
 114      1  Michał Górny
 115      1  Piotr Siupa