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 - Override environments, created when giving construction environment
  33   keyword arguments to Builder calls (or manually, through the
  34   undocumented Override method), were modified not to "leak" on item deletion.
  35   The item will now not be deleted from the base environment.
  36
  37 - Added support for tracking beamer themes in the LaTeX scanner.
  38
  39 - MSVS: msvs project files are always generated before the corresponding
  40   msvs solution files. This changes the behavior of clean for a project
  41   generated with auto_build_solution disabled and explicit solution
  42   generation: when the solution files are cleaned, the project files are
  43   also cleaned.  The tests for vs 6.0-7.1 were updated accordingly.
  44
  45 - MSVS: Add an optional keyword argument, auto_filter_projects, to
  46   MSVSSolution. Accepted values for auto_filter_projects are:
  47   - None [default]: raise an exception when solution file names or nodes
  48     are detected in the projects argument list.
  49   - True or evaluates True: automatically remove solution file names and
  50     nodes from the project argument list.
  51   - False or evaluates False: leave solution file names and nodes in the
  52     project argument list.  An exception is not raised.
  53   Solution file names and/or nodes in the project argument list cause
  54   erroneous Project records to be produced in the generated solution file.
  55   As a convenience, a user may elect to ignore solution file names and nodes
  56   in the projects argument list rather than manually removing solution file
  57   names and nodes from the MSVSProject return values.
  58
  59 - SCons C preprocessor:
  60   - Update the optional integer suffixes to include the z|Z and wb|WB
  61     suffixes.
  62   - Add support for binary integer constants.
  63   - Add support for octal integer constants.  Previously, octal integers
  64     were evaluated as decimal integers.  A literal zero (0) is treated as an
  65     octal number.
  66   - Change the method for attempted conversion of a define expansion value
  67     to an integer from a literal to a constant expression evaluation.
  68
  69 - Add a tag to each CacheDir to let systems ignore backing it up
  70   (per https://bford.info/cachedir/). Update the way a CacheDir
  71   is created, since it now has to create two files.
  72
  73 - The Dictionary method now has an as_dict flag. If true, Dictionary
  74   always returns  a dict. The default remains to return different
  75   types depending on whether zero, one, or multiple construction
  76
  77 FIXES
  78 -----
  79
  80 - PackageVariable now does what the documentation always said it does
  81   if the variable is used on the command line with one of the enabling
  82   string as the value: the variable's default value is produced (previously
  83   it always produced True in this case).
  84
  85 - Temporary files created by TempFileMunge() are now cleaned up on
  86   scons exit, instead of at the time they're used.  Fixes #4595.
  87
  88 - AddOption now correctly adds short (single-character) options.
  89   Previously an added short option would always report as unknown,
  90   while long option names for the same option worked. Short options
  91   that take a value require the user to specify the value immediately
  92   following the option, with no spaces (e.g. -j5 and not -j 5).
  93
  94 - Fix a problem with compilation_db component initialization - the
  95   entries for assembler files were not being set up correctly.
  96
  97 - On Darwin, PermissionErrors are now handled while trying to access
  98   /etc/paths.d. This may occur if SCons is invoked in a sandboxed environment
  99   (such as Nix).
 100
 101 - Added error handling when creating MSVC detection debug log file specified
 102   by SCONS_MSCOMMON_DEBUG.
 103
 104 - MSVS: Modify select msvs test scripts to run on platforms not supported by
 105   the msvs/msvc tool implementation via a default host architecture for
 106   unsupported platforms.
 107
 108 - MSVS: Fixed early loop exit in select msvs test scripts.  Select msvs test
 109   scripts were being invoked for msvc version 8.0 only.  Additional msvs
 110   tool and test changes due to the msvs test scripts being run for all msvc
 111   versions (i.e., minor test and tool issues went undetected).
 112
 113 - MSVS: for variant build configurations, msvs solution files are
 114   generated in the source directory and a placeholder file is generated in
 115   the variant build directory.  This mirrors the behavior of generated
 116   msvs project files.
 117
 118 - MSVS: msvs project files are generated before the corresponding msvs
 119   solution file.  User-specified project GUIDs should now be correctly
 120   written to the solution file.
 121
 122 - SCons C preprocessor: Preserve literals that contain valid integer
 123   substring specifications.  Previously, the integer suffix could be
 124   stripped from a symbol that contained an integer and suffix substring.
 125
 126 - SCons C preprocessor: Update the optional integer suffixes to include
 127   support for the alternate orderings of unsigned with long or long long as
 128   defined in the c/cpp grammar.
 129
 130 - SCons C preprocessor: Update the optional integer suffixes for case
 131   insensitive specifications as defined in the c/cpp grammar.
 132
 133 - Fix nasm test for missing include file, cleanup.
 134
 135 - Skip running a few validation tests if the user is root and the test is
 136   not designed to work for the root user.
 137
 138 IMPROVEMENTS
 139 ------------
 140
 141 - List improvements that wouldn't be visible to the user in the
 142   documentation:  performance improvements (describe the circumstances
 143   under which they would be observed), or major code cleanups
 144
 145 - For consistency with the optparse "add_option" method, AddOption accepts
 146   an SConsOption object as a single argument (this failed previously).
 147   Calling AddOption with the full set of arguments (option names and
 148   attributes) to set up the option is still the recommended approach.
 149
 150 - Add clang and clang++ to the default tool search orders for POSIX
 151   and Windows platforms. These will be searched for after gcc and g++,
 152   respectively. Does not affect explicitly requested tool lists.  Note:
 153   on Windows, SCons currently only has builtin support for clang, not
 154   for clang-cl, the version of the frontend that uses cl.exe-compatible
 155   command line switches.
 156
 157 PACKAGING
 158 ---------
 159
 160 - List changes in the way SCons is packaged and/or released
 161
 162 DOCUMENTATION
 163 -------------
 164
 165 - List any significant changes to the documentation (not individual
 166   typo fixes, even if they're mentioned in src/CHANGES.txt to give
 167   the contributor credit)
 168
 169 - Some manpage cleanup for the gettext and pdf/ps builders.
 170
 171 - Some clarifications in the User Guide "Environments" chapter.
 172
 173 - Clarify documentation of Repository() in manpage and user guide.
 174
 175 - Many grammatical and spelling fixes in the documentation.
 176
 177
 178 DEVELOPMENT
 179 -----------
 180
 181 - List visible changes in the way SCons is developed
 182
 183 Thanks to the following contributors listed below for their contributions to this release.
 184 ==========================================================================================
 185 .. code-block:: text
 186
 187     git shortlog --no-merges -ns 4.0.1..HEAD