RELEASE.txt

   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:
   4
   5     https://scons.org/tag/releases.html
   6
   7 ==================================================================
   8
   9 A new SCons release, 4.4.1, is now available on the SCons download page:
  10
  11     https://scons.org/pages/download.html
  12
  13
  14 Here is a summary of the changes since 4.4.0:
  15
  16 NEW FUNCTIONALITY
  17 -----------------
  18
  19 - List new features (presumably why a checkpoint is being released)
  20
  21 DEPRECATED FUNCTIONALITY
  22 ------------------------
  23
  24 - List anything that's been deprecated since the last release
  25
  26 CHANGED/ENHANCED EXISTING FUNCTIONALITY
  27 ---------------------------------------
  28
  29 - List modifications to existing features, where the previous behavior
  30   wouldn't actually be considered a bug
  31
  32 - Removed Python 3.6 support.
  33
  34 - Override environments, created when giving construction environment
  35   keyword arguments to Builder calls (or manually, through the
  36   undocumented Override method), were modified not to "leak" on item deletion.
  37   The item will now not be deleted from the base environment.
  38
  39 - Added support for tracking beamer themes in the LaTeX scanner.
  40
  41 - MSVS: msvs project files are always generated before the corresponding
  42   msvs solution files. This changes the behavior of clean for a project
  43   generated with auto_build_solution disabled and explicit solution
  44   generation: when the solution files are cleaned, the project files are
  45   also cleaned.  The tests for vs 6.0-7.1 were updated accordingly.
  46
  47 - MSVS: Add an optional keyword argument, auto_filter_projects, to
  48   MSVSSolution. Accepted values for auto_filter_projects are:
  49   - None [default]: raise an exception when solution file names or nodes
  50     are detected in the projects argument list.
  51   - True or evaluates True: automatically remove solution file names and
  52     nodes from the project argument list.
  53   - False or evaluates False: leave solution file names and nodes in the
  54     project argument list.  An exception is not raised.
  55   Solution file names and/or nodes in the project argument list cause
  56   erroneous Project records to be produced in the generated solution file.
  57   As a convenience, a user may elect to ignore solution file names and nodes
  58   in the projects argument list rather than manually removing solution file
  59   names and nodes from the MSVSProject return values.
  60
  61 - SCons C preprocessor:
  62   - Update the optional integer suffixes to include the z|Z and wb|WB
  63     suffixes.
  64   - Add support for binary integer constants.
  65   - Add support for octal integer constants.  Previously, octal integers
  66     were evaluated as decimal integers.  A literal zero (0) is treated as an
  67     octal number.
  68   - Change the method for attempted conversion of a define expansion value
  69     to an integer from a literal to a constant expression evaluation.
  70
  71 - Add a tag to each CacheDir to let systems ignore backing it up
  72   (per https://bford.info/cachedir/). Update the way a CacheDir
  73   is created, since it now has to create two files.
  74
  75 - The Dictionary method now has an as_dict flag. If true, Dictionary
  76   always returns  a dict. The default remains to return different
  77   types depending on whether zero, one, or multiple construction
  78
  79 - A Variables object now makes available a "defaulted" attribute,
  80   a list of variable names that were set in the environment with
  81   their values taken from the default in the variable description
  82   (if a variable was set to the same value as the default in one
  83   of the input sources, it is not included in this list).
  84
  85 FIXES
  86 -----
  87
  88 - PackageVariable now does what the documentation always said it does
  89   if the variable is used on the command line with one of the enabling
  90   string as the value: the variable's default value is produced (previously
  91   it always produced True in this case).
  92
  93 - Temporary files created by TempFileMunge() are now cleaned up on
  94   scons exit, instead of at the time they're used.  Fixes #4595.
  95
  96 - AddOption now correctly adds short (single-character) options.
  97   Previously an added short option would always report as unknown,
  98   while long option names for the same option worked. Short options
  99   that take a value require the user to specify the value immediately
 100   following the option, with no spaces (e.g. -j5 and not -j 5).
 101
 102 - Fix a problem with compilation_db component initialization - the
 103   entries for assembler files were not being set up correctly.
 104
 105 - On Darwin, PermissionErrors are now handled while trying to access
 106   /etc/paths.d. This may occur if SCons is invoked in a sandboxed environment
 107   (such as Nix).
 108
 109 - Added error handling when creating MSVC detection debug log file specified
 110   by SCONS_MSCOMMON_DEBUG.
 111
 112 - MSVS: Modify select msvs test scripts to run on platforms not supported by
 113   the msvs/msvc tool implementation via a default host architecture for
 114   unsupported platforms.
 115
 116 - MSVS: Fixed early loop exit in select msvs test scripts.  Select msvs test
 117   scripts were being invoked for msvc version 8.0 only.  Additional msvs
 118   tool and test changes due to the msvs test scripts being run for all msvc
 119   versions (i.e., minor test and tool issues went undetected).
 120
 121 - MSVS: for variant build configurations, msvs solution files are
 122   generated in the source directory and a placeholder file is generated in
 123   the variant build directory.  This mirrors the behavior of generated
 124   msvs project files.
 125
 126 - MSVS: msvs project files are generated before the corresponding msvs
 127   solution file.  User-specified project GUIDs should now be correctly
 128   written to the solution file.
 129
 130 - SCons C preprocessor: Preserve literals that contain valid integer
 131   substring specifications.  Previously, the integer suffix could be
 132   stripped from a symbol that contained an integer and suffix substring.
 133
 134 - SCons C preprocessor: Update the optional integer suffixes to include
 135   support for the alternate orderings of unsigned with long or long long as
 136   defined in the c/cpp grammar.
 137
 138 - SCons C preprocessor: Update the optional integer suffixes for case
 139   insensitive specifications as defined in the c/cpp grammar.
 140
 141 - Fix nasm test for missing include file, cleanup.
 142
 143 - Skip running a few validation tests if the user is root and the test is
 144   not designed to work for the root user.
 145
 146 - Make sure unknown variables from a Variables file are recognized
 147   as such. Previously only unknowns from the command line were
 148   recognized (issue #4645).
 149
 150 - Update ninja tool to use ninja.BIN_DIR to find pypi packaged ninja binary.
 151   python ninja package version 1.11.1.2 changed the location and previous
 152   logic no longer worked.
 153
 154 - The (optional) C Conditional Scanner now does limited macro
 155   replacement on the contents of CPPDEFINES, to improve finding deps
 156   that are conditionally included.  Previously replacement was only
 157   done on macro definitions found in the file being scanned.
 158   Only object-like macros are replaced (not function-like), and
 159   only on a whole-word basis; recursion is limited to five levels
 160   and does not error out if that limit is reached (issue #4523).
 161
 162 IMPROVEMENTS
 163 ------------
 164
 165 - List improvements that wouldn't be visible to the user in the
 166   documentation:  performance improvements (describe the circumstances
 167   under which they would be observed), or major code cleanups
 168
 169 - For consistency with the optparse "add_option" method, AddOption accepts
 170   an SConsOption object as a single argument (this failed previously).
 171   Calling AddOption with the full set of arguments (option names and
 172   attributes) to set up the option is still the recommended approach.
 173
 174 - Add clang and clang++ to the default tool search orders for POSIX
 175   and Windows platforms. These will be searched for after gcc and g++,
 176   respectively. Does not affect explicitly requested tool lists.  Note:
 177   on Windows, SCons currently only has builtin support for clang, not
 178   for clang-cl, the version of the frontend that uses cl.exe-compatible
 179   command line switches.
 180
 181 PACKAGING
 182 ---------
 183
 184 - List changes in the way SCons is packaged and/or released
 185
 186 DOCUMENTATION
 187 -------------
 188
 189 - List any significant changes to the documentation (not individual
 190   typo fixes, even if they're mentioned in src/CHANGES.txt to give
 191   the contributor credit)
 192
 193 - Some manpage cleanup for the gettext and pdf/ps builders.
 194
 195 - Some clarifications in the User Guide "Environments" chapter.
 196
 197 - Clarify documentation of Repository() in manpage and user guide.
 198
 199 - Many grammatical and spelling fixes in the documentation.
 200
 201 - Update Clean and NoClean documentation.
 202
 203 DEVELOPMENT
 204 -----------
 205
 206 - List visible changes in the way SCons is developed
 207
 208 - Ruff/Mypy: Excluded items now synced.
 209
 210 - Ruff: Linter includes new rules - `FA`, `UP006`, `UP007`, and `UP037` - to
 211   detect and upgrade legacy type-hint syntax.
 212
 213 - Removed "SCons.Util.sctyping.py", as the functionality can now be substituted
 214   via top-level `from __future__ import annotations`.
 215
 216 - Implemented type hints for Nodes.
 217
 218 - Added TestSCons.NINJA_BINARY to TestSCons to centralize logic to find ninja binary
 219
 220 - Refactored SCons.Tool.ninja -> SCons.Tool.ninja_tool, and added alias so env.Tool('ninja')
 221   will still work. This avoids conflicting with the pypi module ninja.
 222
 223 Thanks to the following contributors listed below for their contributions to this release.
 224 ==========================================================================================
 225 .. code-block:: text
 226
 227     git shortlog --no-merges -ns 4.0.1..HEAD