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 FIXES
  38 -----
  39
  40 - PackageVariable now does what the documentation always said it does
  41   if the variable is used on the command line with one of the enabling
  42   string as the value: the variable's default value is produced (previously
  43   it always produced True in this case).
  44 - Temporary files created by TempFileMunge() are now cleaned up on
  45   scons exit, instead of at the time they're used.  Fixes #4595.
  46 - AddOption now correctly adds short (single-character) options.
  47   Previously an added short option would always report as unknown,
  48   while long option names for the same option worked. Short options
  49   that take a value require the user to specify the value immediately
  50   following the option, with no spaces (e.g. -j5 and not -j 5).
  51 - Fix a problem with compilation_db component initialization - the
  52   entries for assembler files were not being set up correctly.
  53 - On Darwin, PermissionErrors are now handled while trying to access
  54   /etc/paths.d. This may occur if SCons is invoked in a sandboxed environment
  55   (such as Nix).
  56 - Added error handling when creating MS VC detection debug log file specified by
  57   SCONS_MSCOMMON_DEBUG
  58
  59 IMPROVEMENTS
  60 ------------
  61
  62 - List improvements that wouldn't be visible to the user in the
  63   documentation:  performance improvements (describe the circumstances
  64   under which they would be observed), or major code cleanups
  65
  66 - For consistency with the optparse "add_option" method, AddOption accepts
  67   an SConsOption object as a single argument (this failed previouly).
  68   Calling AddOption with the full set of arguments (option names and
  69   attributes) to set up the option is still the recommended approach.
  70
  71 - Add clang and clang++ to the default tool search orders for POSIX
  72   and Windows platforms. These will be searched for after gcc and g++,
  73   respectively. Does not affect expliclity requested tool lists.  Note:
  74   on Windows, SCons currently only has builtin support for clang, not
  75   for clang-cl, the version of the frontend that uses cl.exe-compatible
  76   command line switches.
  77
  78 PACKAGING
  79 ---------
  80
  81 - List changes in the way SCons is packaged and/or released
  82
  83 DOCUMENTATION
  84 -------------
  85
  86 - List any significant changes to the documentation (not individual
  87   typo fixes, even if they're mentioned in src/CHANGES.txt to give
  88   the contributor credit)
  89
  90 - Some manpage cleanup for the gettext and pdf/ps builders.
  91 - Some clarifications in the User Guide "Environments" chapter.
  92
  93 DEVELOPMENT
  94 -----------
  95
  96 - List visible changes in the way SCons is developed
  97
  98 Thanks to the following contributors listed below for their contributions to this release.
  99 ==========================================================================================
 100 .. code-block:: text
 101
 102     git shortlog --no-merges -ns 4.0.1..HEAD