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.5.3, 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.5.2:
  15
  16 NEW FUNCTIONALITY
  17 -----------------
  18
  19 - D compilers : added support for generation of .di interface files.
  20   New variables DI_FILE_DIR, DI_FILE_DIR_PREFIX, DI_FILE_DIR_SUFFIX,
  21   DI_FILE_SUFFIX.
  22 - MSVC: If available, native arm64 tools will be used on arm64 hosts for VS2022.
  23 - MSVC: If necessary, automatically define VSCMD_SKIP_SENDTELEMETRY for VS2019 and later
  24   on arm64 hosts when using an arm (32-bit) build of python to prevent a powershell
  25   error pop-up window (powershell dll not found).
  26
  27 DEPRECATED FUNCTIONALITY
  28 ------------------------
  29
  30 - List anything that's been deprecated since the last release
  31
  32 CHANGED/ENHANCED EXISTING FUNCTIONALITY
  33 ---------------------------------------
  34
  35 - When debugging (--debug=pdb), the filenames SConstruct and SConscript
  36   are now recognized when manipulating breakpoints. Previously,
  37   only a full pathname to an sconscript file worked, as pdb requires
  38   a .py extension to open a file that is not an absolute path.
  39 - Three unused non-public methods of the Environment Base class
  40   were dropped: get_src_sig_type, get_tgt_sig_type, _changed_source.
  41   These were unused remnants of the previously removed SourceSignatures
  42   and TargetSignatures features (dropped in 3.1.2).
  43 - The --debug flag now has a 'json' option which will write information
  44   generated by --debug={count, memory, time, action-timestamps} and about
  45   the build.
  46 - Obsoleted YACCVCGFILESUFFIX, it's being replaced by YACC_GRAPH_FILE_SUFFIX.
  47   If YACC_GRAPH_FILE_SUFFIX is not set, it will respect YACCVCGFILESUFFIX.
  48 - The yacc tool now understands the bison behavior of --header, --defines
  49   and --graph being called without an option-argument as being synonyms
  50   for -d (first two) and -g. -H also recognized as a synonym for -d.
  51   Default value for $YACC_GRAPH_FILE_SUFFIX changed to '.gv' to match
  52   current bison default (since bison 3.8). Set this variable to '.dot'
  53   if using byacc. Fixes #4326 and #4327.
  54 - MSVC: When trying to find a valid msvc batch file, the existence of the msvc compiler
  55   executable is verified for VS6 to VS2015 to avoid executing the msvc batch file when
  56   the host/target tool is known not to be present. Always check that the msvc compiler
  57   executable is found on the msvc script environment path after running the msvc batch
  58   file.  This is predominately needed for recent versions of Visual Studio where the msvc
  59   batch file exists but an individual msvc toolset may not support the host/target
  60   architecture combination.  For example, when using VS2022 on arm64, the arm64 native
  61   tools are only installed for the 14.3x toolsets.
  62 - Extend range of recognized Java versions to 20.
  63 - Builder calls (like Program()) now accept pathlib objects in source lists.
  64 - The Help() function now takes an additional keyword argument keep_local:
  65   when starting to build a help message, you can now retain help from AddOption
  66   calls (options added for the project_, but omit help for SCons' own cmdline
  67   options with "Help(newtext, append=True, local_only=True)".
  68 - Calling SConscript() with a nonexistent file is now an error.
  69   Previously this succeeded - prior to SCons 3.0, silently; since 3.0, with
  70   a warning. Developers can still instruct such an SConscript() call not
  71   to fail by being explicit: pass keyword argument "must_exist=False".
  72   The "--warn=missing-sconscript" commandline option is no longer available
  73   as the warning was part of the transitional phase.
  74 - Add missing directories to searched paths for mingw installs
  75 - SCons.Util.types renamed to to SCons.Util.sctypes to avoid any possible
  76   confusion with the Python stdlib "types" module. Note that it was briefly
  77   (for 4.5.x only) possible to import directly from SCons.Util.types,
  78   although the preferred usage remains to import from SCons.Util only.
  79   Any code that did the direct import will have to change to import from
  80   SCons.Util.sctypes.
  81 - Add JDK 21 LTS support
  82 - The newly added --debug=sconscript optiont (new) will output notices when
  83   entering an exiting each SConscript as they are processed.
  84
  85 FIXES
  86 -----
  87
  88 - Fixed: when using the mingw tool, if an msys2 Python is used (os.sep
  89   is '/' rather than the Windows default '\'), certain Configure checks
  90   could fail due to the construction of the path to run the compiled check.
  91 - C scanner's dictifyCPPDEFINES routine did not understand the possible
  92   combinations of CPPDEFINES - not aware of a "name=value" string either
  93   embedded in a sequence, or by itself.  The conditional C scanner thus
  94   did not always properly apply the defines. The regular C scanner does
  95   not use these, so was not affected.  [fixes #4193]
  96 - MSVC: The installed msvc list is calculated once and cached.  There was an indirect
  97   dependency on the target architecture when determining if each version of msvc
  98   was installed based on the initial invocation.  It was possible that an msvc instance
  99   would not be considered installed due to the tools for the requested target
 100   architecture not being installed.  The initial call to construct the installed msvc
 101   list now uses an undefined target architecture to evaluate all potential host/target
 102   combinations when evaluating if the msvc tools are installed for a given Visual Studio
 103   installation.
 104 - MSVC: Erroneous construction of the installed msvc list (as described above) caused an
 105   index error in the msvc support code.  An explicit check was added to prevent indexing
 106   into an empty list.  Fixes #4312.
 107 - MSCommon: Test SConfTests.py would fail when mscommon debugging was enabled via the
 108   MSVC_MSCOMMON_DEBUG environment variable.  The mscommon logging filter class registered
 109   with the python logging module was refactored to prevent test failure.
 110 - MSVS: Add arm64 to the MSVS supported architectures list for VS2017 and later to be
 111   consistent with the current documentation of MSVS_ARCH.
 112 - FORTRAN: Fix gfortran tool initialization. Defaults to using binary named gfortran
 113   as would be expected, and properly set's SHFORTRAN flags to include -fPIC
 114   where previously it was only doing so for the other fortran versions (F77,..)
 115 - MSCommon: Added more error handling while reading msvc config cache.
 116   (Enabled/specified by SCONS_CACHE_MSVC_CONFIG).
 117   The existing cache will be discarded if there's a decode error reading it.
 118   It's possible there's a race condition creating this issue it in certain CI builds.
 119 - Fixed: race condition in `Mkdir` which can happen when two `SConscript`
 120   are processed simultaneously by two separate build commands.
 121
 122 IMPROVEMENTS
 123 ------------
 124
 125 - Now tries to find mingw if it comes from Chocolatey install of msys2.
 126 - MSVC: Module imports were changed from a relative import to a top-level
 127   absolute import in the following Microsoft tools: midl, mslib, mslink, mssdk, msvc,
 128   msvs. Moving any of these tools that used relative imports to the scons site tools
 129   folder would fail on import (i.e., the relative import paths become invalid when
 130   moved).
 131
 132 PACKAGING
 133 ---------
 134
 135 - The build of scons now matches the help text displayed - the targets
 136   listed there can all now be given as a target to build (except for
 137   the two full source balls; the source tar.gz is currently generated directly
 138   by the GitHub release process).
 139
 140 DOCUMENTATION
 141 -------------
 142
 143 - Aligned manpage signature for Alias function to match implementation -
 144   if the previous *targets* parameter had been used as a keyword argument,
 145   the results would be incorrect (does not apply to positional argument
 146   usage, which had no problem).
 147 - Changed the message about scons -H to clarify it shows built-in options only.
 148 - Cachedir description updated.
 149 - Updated the first two chapters on building with SCons in the User Guide.
 150 - Clarify that exported variables are shared - if mutable, changes made in
 151   an SConscript are visible everywhere that takes a refereence to that object.
 152
 153 DEVELOPMENT
 154 -----------
 155
 156 - SCons test runner now uses pathlib to normalize and compare paths
 157   to test files, which allows test lists, exclude lists, and tests on
 158   the command line to "not care" about the OS convention for pathname
 159   separators.
 160 - Class ActionBase is now an abstract base class to more accurately
 161   reflect its usage. Derived _ActionAction inherits the ABC, so it
 162   now declares (actually raises NotImplementedError) two methods it
 163   doesn't use so it can be instantiated by unittests and others.
 164 - Added more type annotations to internal routines.
 165 - Cleaned up dblite module (checker warnings, etc.).
 166 - TeX tests: skip tests that use makeindex or epstopdf not installed, or
 167   if `kpsewhich glossaries.sty` fails.
 168
 169 Thanks to the following contributors listed below for their contributions to this release.
 170 ==========================================================================================
 171 .. code-block:: text
 172
 173     git shortlog --no-merges -ns 4.5.2..HEAD