summaryrefslogtreecommitdiff
path: root/RELEASE.txt
blob: 6c1c5f281696594c41a36e0ee9b0e58db76fa597 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
If you are reading this in the git repository, the contents
refer to *unreleased* changes since the last SCons release.
Past official release announcements appear at:

    https://scons.org/tag/releases.html

==================================================================

A new SCons release, 4.4.1, is now available on the SCons download page:

    https://scons.org/pages/download.html


Here is a summary of the changes since 4.4.0:

NOTE: If you build with Python 3.10.0 and then rebuild with 3.10.1 (or higher), you may
      see unexpected rebuilds. This is due to Python internals changing which changed
      the signature of a Python Action Function.


NEW FUNCTIONALITY
-----------------

- Added ValidateOptions() which will check that all command line options are in either
  those specified by SCons itself, or by AddOption() in SConstruct/SConscript.  It should
  not be called until all AddOption() calls are completed. Resolves Issue #4187
- Added --experimental=tm_v2, which enables Andrew Morrow's NewParallel Job implementation.
  This should scale much better for highly parallel builds.  You can also enable this via SetOption().


DEPRECATED FUNCTIONALITY
------------------------

- List anything that's been deprecated since the last release

CHANGED/ENHANCED EXISTING FUNCTIONALITY
---------------------------------------

- Added -fsanitize support to ParseFlags().  This will propagate to CCFLAGS and LINKFLAGS.
- Calling EnsureSConsVersion() and EnsurePythonVersion() won't initialize
  DefaultEnvironment anymore.
- The console message from the Chmod() action function now displays
  octal modes using the modern Python syntax (0o755 rather than 0755).
- Migrated logging logic for --taskmastertrace to use Python's logging module. Added logging
  to NewParallel Job class (Andrew Morrow's new parallel job implementation)
- Preliminary support for Python 3.12.
- Run LaTeX after biber/bibtex only if necessary
- Configure context methods CheckLib and CheckLibWithHeader now expose
  two additional keyword arguments: 'append', which controls whether to append
  (the default) or prepend discovered libraries to $LIBS, and 'unique',
  which controls whether to add the library if it is already in the $LIBS
  list. This brings the library-adding functionality in Configure in line
  with the regular Append, AppendUnique, Prepend and PrependUnique methods.


FIXES
-----

- Added missing newline to generated compilation database (compile_commands.json)
- A list argument as the source to the Copy() action function is now handled.
  Both the implementation and the strfunction which prints the progress
  message were adjusted.
- The Java Scanner processing of JAVACLASSPATH for dependencies (behavior
  that was introduced in SCons 4.4.0) is adjusted to split on the system's
  search path separator instead of on a space. The previous behavior meant
  that a path containing spaces (e.g. r"C:\somepath\My Classes") would
  lead to unexpected errors. If the split-on-space behavior is desired,
  pre-split the value: instead of: env["JAVACLASSPATH"] = "foo bar baz"
  use: env["JAVACLASSPATH"] = env.Split("foo bar baz")
  There is no change in how JAVACLASSPATH gets turned into the -classpath
  argument passed to the JDK tools.
- Ninja: Fix execution environment sanitation for launching ninja. Previously if you set an
  execution environment variable set to a python list it would crash. Now it
  will create a string joining the list with os.pathsep
- Fixed command line argument --diskcheck: previously a value of 'none' was ignored.
  SetOption('diskcheck','none') is unaffected, as it did not have the problem.
- Fixed Issue #4275 - when outputting compilation db and TEMPFILE was in use, the compilation db would have
  command lines using the generated tempfile for long command lines, instead of the full command line for
  the compilation step for the source/target pair.
- A refactor in the caching logic for version 4.4.0 left Java inner classes
  failing with an exception when a CacheDir was enabled. This is now corrected.
- When using the gfortran tool (the default on most platforms as long as a GNU
  toolchain is installed), the user setting of the "dialect" compilers
  (F77, F90, F03 and F09, as well as the shared-library equivalents SHF77,
  SHF90, SHF03, SHF09) is now honored; previously the tool overwrote the
  settings to 'gfortran', which made it difficult reference a cross-compile
  version for dialects.
- Fix issue #2757, where Configure checks that perform a check which reads a modified source
  (including program, source or header file(s)) would incorrectly mark that file "up to date" so the
  actual build would not see the file as modified. Leading to incorrect incremental builds.
  Now configure checks now clear node info for non conftest nodes, so they will be re-evaluated for
  the real taskmaster run when the build commences.


IMPROVEMENTS
------------

- Changed the Taskmaster trace logic to use python's logging module.
- Add cache-debug messages for push failures.
- Added error message to handle the case when SCons attempts to retrieve all the targets
  for a specified builder from the CacheDir, fails to do so, and then runs into an error
  when deleting the files which were retrieved. Previously if this happened there were no
  errors or warnings.

PACKAGING
---------

- SCons now has three requirements files: requirements.txt describes
  requirements to run scons; requirements-dev.txt requirements to
  develop it - mainly things needed to run the testsuite;
  requirements_pkg.txt are the requirements to do a full build
  (including docs build) with an intent to create the packages.
- Moved rpm and debian directories under packaging
- Added logic to help packagers enable reproducible builds into packaging/etc/.
  Please read packaging/etc/README.txt if you are interested.
- A zipapp of scons-local is now also built.


DOCUMENTATION
-------------

- Updated the --hash-format manpage entry.
- EnsureSConsVersion, EnsurePythonVersion, Exit, GetLaunchDir and
  SConscriptChdir are now listed as Global functions only.
- Updated the docs for Glob.
- Updated SHELL_ENV_GENERATORS description and added versionadded indicator.
- JAVABOOTCLASSPATH, JAVACLASSPATH and JAVASOURCEPATH better document the
  acceptable syntax for values, and how they will be interpreted,
  including that JAVACLASSPATH will be scanned for dependencies.
  Added note on the possibly surprising feature that SCons always passes
  -sourcepath when calling javac, which affects how the class path is
  used when finding sources.
- Updated the User Guide chapter on installation: modernized the notes
  on Python installs, SCons installs, and having multiple SCons versions
  present on a single system.
- Updated the User Guide chapter on variant directories with more
  explanation, and the introduction of terms like "out of tree" that
  may help in forming a mental model.
- Additional explanations for MSVSProject and MSVSSolution builders.
- Updated MSVC documentation - adds "version added" annotations on recently
  added construction variables and provides a version-mapping table.

DEVELOPMENT
-----------

- Refactored SCons/Taskmaster into a package. Moved SCons/Jobs.py into that package.
  NOTE: If you hook into SCons.Jobs, you'll have to change that to use SCons.Taskmaster.Jobs
- Refactored SCons.Util, which had grown quite large, to be a package,
  not a single-file module. Change should be transparent: the same import
  of SCons.Util and public symbols from it will continue to work, however
  code which reaches directly in to grab private symbols (starting with
  underscore) which moved to a submodule, that code will have to be adjusted,
  as those are not imported to the package level (new SCons.Util.hashes has
  some of these, which are used by existing unit tests).
- Added overrides argument to SCons.Subst.scons_subst(), subst_list(), subst(), and Action's process(),
  strfunction(). This allows passing a dictionary of envvars to override when evaluating subst()'d strings/lists


Thanks to the following contributors listed below for their contributions to this release.
==========================================================================================
.. code-block:: text

    git shortlog --no-merges -ns 4.4.0..HEAD