Merge branch 'master' into maint/Value

Author: bdbaddog

CHANGES.txt

@@ -9,6 +9,13 @@ NOTE: 4.3.0 now requires Python 3.6.0 and above. Python 3.5.x is no longer suppo
 
 RELEASE  VERSION/DATE TO BE FILLED IN LATER
 
+  From Mats Wichmann:
+
+    - Updated Value Node docs and tests.
+
+
+RELEASE 4.7.0 -  Sun, 17 Mar 2024 17:22:20 -0700
+
   From Ataf Fazledin Ahamed:
     - Use of NotImplemented instead of NotImplementedError for special methods
       of _ListVariable class
@@ -44,14 +51,15 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
       prototype when including a header file.
 
   From Thaddeus Crews:
+    - Explicitly wrap non-serializable values in json dump
     - Implemented SCons.Util.sctyping as a safe means of hinting complex types. Currently
       only implemented for `Executor` as a proof-of-concept.
 
   From William Deegan:
     - Fix sphinx config to handle SCons versions with post such as: 4.6.0.post1
 
   From Michał Górny:
-    - Remove unecessary dependencies on pypi packages from setup.cfg
+    - Remove unnecessary dependencies on pypi packages from setup.cfg
 
   From Sten Grüner:
     - Fix of the --debug=sconscript option to return exist statements when using return
@@ -108,7 +116,11 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
       DeprecatedMissingSConscriptWarning) add two warnings to manpage
       (cache-cleanup-error, future-reserved-variable), improve unittest, tweak
       Sphinx build.
-    - Updated Value Node docs and tests.
+    - Add locking around creation of CacheDir config file. Fixes #4489.
+    - Clarify MergeFlags usage of a dict argument.
+    - SCons documentation build can now be controlled through SKIP_DOC
+      variable - rather than just true/false can now specify
+      skip none, skip all, skip pdf docs, skip api docs.
 
 
 RELEASE 4.6.0 -  Sun, 19 Nov 2023 17:22:20 -0700

README-SF.rst

@@ -134,7 +134,7 @@ By default, the above commands will do the following:
 - Install scripts named "scons" and "sconsign" scripts in the default system
   script directory (/usr/bin or C:\\Python\*\\Scripts, for example).
 
-- Install "scons-4.5.1.exe" and "scons.exe" executables in the Python
+- Install "scons-4.7.0.exe" and "scons.exe" executables in the Python
   prefix directory on Windows (C:\\Python\*, for example).
 
 - Install the SCons build engine (a Python module) in the standard Python library directory
@@ -391,7 +391,7 @@ about `Executing SCons Without Installing`_)::
 Depending on the utilities installed on your system, any or all of the
 following packages will be built::
 
-    SCons-4.5.1-py3-none-any.whl
+    SCons-4.7.0-py3-none-any.whl
     SCons-4.7.0ayyyymmdd.tar.gz
     SCons-4.7.0ayyyymmdd.zip
     scons-doc-4.7.0ayyyymmdd.tar.gz

README-package.rst

@@ -192,5 +192,5 @@ For More Information
 Check the SCons web site at https://www.scons.org/
 
 
-Copyright (c) 2001 - 2021 The SCons Foundation
+Copyright (c) 2001 - 2024 The SCons Foundation
 

README.rst

@@ -299,4 +299,4 @@ many contributors, including but not at all limited to:
 
 \... and many others.
 
-Copyright (c) 2001 - 2021 The SCons Foundation
+Copyright (c) 2001 - 2024 The SCons Foundation

RELEASE.txt

@@ -6,20 +6,17 @@ Past official release announcements appear at:
 
 ==================================================================
 
-A new SCons release, 4.6.1, is now available on the SCons download page:
+A new SCons release, 4.7.1, is now available on the SCons download page:
 
     https://scons.org/pages/download.html
 
 
-Here is a summary of the changes since 4.6.0:
+Here is a summary of the changes since 4.7.0:
 
 NEW FUNCTIONALITY
 -----------------
 
-- Method unlink_files was added to the TestCmd class that unlinks a list of files
-  from a specified directory.  An attempt to unlink a file is made only when the
-  file exists; otherwise, the file is ignored.
-
+- List new features (presumably why a checkpoint is being released)
 
 DEPRECATED FUNCTIONALITY
 ------------------------
@@ -29,90 +26,41 @@ DEPRECATED FUNCTIONALITY
 CHANGED/ENHANCED EXISTING FUNCTIONALITY
 ---------------------------------------
 
-- Add an optional argument list string to configure's CheckFunc method so
-  that the generated function argument list matches the function's
-  prototype when including a header file. Fixes GH Issue #4320
-- Now supports pre-release Python 3.13
-- Support for Python versions without support for the `threading` package has been removed
-- Dropped three unused warning classes: DeprecatedSourceCodeWarning,
-  TaskmasterNeedsExecuteWarning, DeprecatedMissingSConscriptWarning.
-* Two warning classes that are actually used were added to manpage section on
-  enabling warnings (cache-cleanup-error, future-reserved-variable).
+- List modifications to existing features, where the previous behavior
+  wouldn't actually be considered a bug
 
 FIXES
 -----
 
-- Fix of the --debug=sconscript option to return exist statements when using return
-  statement with stop flag enabled
-- MSVS: prevent overwriting the SCons environment variable SCONS_HOME with the OS
-  environment value of SCONS_HOME in the msvs tool.
-- MSVC: Fix the detection of Visual Studio 2015 Express ('14.0Exp') by adding a
-  registry key definition and updating the installation root-relative registry value
-  at runtime for the location of the VC folder.
-- MSVS: Fix the msvs project generation test for MSVS 6.0 to use the correct name of
-  the generated project file.
-- MSVS: Fix the msvs project generation test scripts so that "false positive" tests
-  results are not possible when the initial build is successful and the command-line
-  build of the project file fails.
-- On Windows platform, when collecting command output (Configure checks),
-  make sure decoding of bytes doesn't fail.
-- Documentation indicated that both Pseudo() and env.Pseudo() were usable,
-  but Pseudo() did not work; is now enabled.
-- Improve handling of file data that SCons itself processes - as in
-  scanners - try harder to decode non-UTF-8 text.
-- PyPackageDir no longer fails if passed a module name which cannot be found,
-  now returns None.
-
+- List fixes of outright bugs
 
 IMPROVEMENTS
 ------------
 
-- Use of NotImplemented instead of NotImplementedError for special methods
-  of _ListVariable class
-- The NewParallel scheduler is now the default, the `tm_v2` flag is removed,
-  and the old scheduler is opt-in under `--experimental=legacy_sched`. Additionally,
-  the new scheduler is now used for -j1 builds as well.
-  NOTE: This should significantly improve SCons performance for larger parallel builds
-        (Larger -j values)
-- CacheDir writes no longer happen within the taskmaster critical section, and therefore
-  can run in parallel with both other CacheDir writes and the taskmaster DAG walk.
-- The NewParallel scheduler now only adds threads as new work requiring execution
-  is discovered, up to the limit set by -j. This should reduce resource utilization
-  when the achievable parallelism in the DAG is less than the -j limit.
-
+- List improvements that wouldn't be visible to the user in the
+  documentation:  performance improvements (describe the circumstances
+  under which they would be observed), or major code cleanups
 
 PACKAGING
 ---------
 
-- Remove unecessary dependencies on pypi packages from setup.cfg
+- List changes in the way SCons is packaged and/or released
 
 
 DOCUMENTATION
 -------------
 
-- Fixed the Scanner examples in the User Guide to be runnable and added
-  some more explanation. Clarified discussion of the scanner function in
-  the Scanner Objects section of the manpage.
-- The manpage entry for Pseudo was clarified.
-- The manpage entry for SharedLibrary was clarified.
-- Update API docs for Warnings framework; add two warns to manpage
-  enable/disable control.
-- More consistent use of &Python; in the manpage.  A few links added.
-  A warning about overwriting env['ENV'] and one about Configure
-  checks possibly not running in in no-exec mode also added.
-- Clarify how SCons finds the project top directory, and what that is used for.
 - Updated Value Node docs.
 
 
+
 DEVELOPMENT
 -----------
 
-- Fix sphinx config to handle SCons versions with post such as: 4.6.0.post1
-- Created SCons.Util.sctyping to contain complex type information, allowing
-  for repo-wide type hinting without causing cyclical dependencies.
+- List visible changes in the way SCons is developed
 
 Thanks to the following contributors listed below for their contributions to this release.
 ==========================================================================================
 .. code-block:: text
 
-    git shortlog --no-merges -ns 4.6.0..HEAD
+    git shortlog --no-merges -ns 4.0.1..HEAD

ReleaseConfig

@@ -31,7 +31,7 @@
 # If the release type is not 'final', the patchlevel is set to the
 # release date.  This value is mandatory and must be present in this file.
 #version_tuple = (2, 2, 0, 'final', 0)
-version_tuple = (4, 6, 1, 'a', 0)
+version_tuple = (4, 6, 2, 'a', 0)
 
 # Python versions prior to unsupported_python_version cause a fatal error
 # when that version is used.  Python versions prior to deprecate_python_version

SCons/CacheDir.py

@@ -34,7 +34,7 @@
 import SCons.Action
 import SCons.Errors
 import SCons.Warnings
-import SCons
+import SCons.Util
 
 cache_enabled = True
 cache_debug = False
@@ -169,15 +169,16 @@ def _readconfig(self, path):
         """
         config_file = os.path.join(path, 'config')
         try:
+            # still use a try block even with exist_ok, might have other fails
             os.makedirs(path, exist_ok=True)
-        except FileExistsError:
-            pass
         except OSError:
             msg = "Failed to create cache directory " + path
             raise SCons.Errors.SConsEnvironmentError(msg)
 
         try:
-            with open(config_file, 'x') as config:
+            with SCons.Util.FileLock(config_file, timeout=5, writer=True), open(
+                config_file, "x"
+            ) as config:
                 self.config['prefix_len'] = 2
                 try:
                     json.dump(self.config, config)
@@ -186,9 +187,11 @@ def _readconfig(self, path):
                     raise SCons.Errors.SConsEnvironmentError(msg)
         except FileExistsError:
             try:
-                with open(config_file) as config:
+                with SCons.Util.FileLock(config_file, timeout=5, writer=False), open(
+                    config_file
+                ) as config:
                     self.config = json.load(config)
-            except ValueError:
+            except (ValueError, json.decoder.JSONDecodeError):
                 msg = "Failed to read cache configuration for " + path
                 raise SCons.Errors.SConsEnvironmentError(msg)
 

SCons/Environment.py

@@ -1720,7 +1720,7 @@ def Dump(self, key=None, format: str='pretty'):
         elif fmt == 'json':
             import json
             def non_serializable(obj):
-                return str(type(obj).__qualname__)
+                return '<<non-serializable: %s>>' % type(obj).__qualname__
             return json.dumps(cvars, indent=4, default=non_serializable)
         else:
             raise ValueError("Unsupported serialization format: %s." % fmt)

SCons/Environment.xml

@@ -638,7 +638,7 @@ In this case, space-separated strings are not split.</para>
 </listitem>
 <listitem>
 <para>A dictionary is processed in order,
-adding each key:value pair as a valued macro.
+adding each key-value pair as a valued macro.
 Use the value <constant>None</constant> if the macro should not have a value.
 </para>
 </listitem>
@@ -723,7 +723,7 @@ Appending a string <parameter>val</parameter>
 to a dictonary-typed &consvar; enters
 <parameter>val</parameter> as the key in the dictionary,
 and <literal>None</literal> as its value.
-Using a tuple type to supply a <literal>key, value</literal>
+Using a tuple type to supply a key-value pair
 only works for the special case of &cv-CPPDEFINES;
 described above.
 </para>
@@ -2342,35 +2342,38 @@ env.MergeShellPaths({'INCLUDE': ['c:/inc1', 'c:/inc2']}, prepend=0)
 <para>
 Merges values from
 <parameter>arg</parameter>
-into &consvars; in the current &consenv;.
-If
-<parameter>arg</parameter>
+into &consvars; in <parameter>env</parameter>.
+If <parameter>arg</parameter> is a dictionary,
+each key-value pair represents a
+&consvar; name and the corresponding flags to merge.
+If <parameter>arg</parameter>
 is not a dictionary,
-it is converted to one by calling
-&f-link-env-ParseFlags;
-on the argument
+&MergeFlags; attempts to convert it to one
 before the values are merged.
-Note that
+&f-link-env-ParseFlags; is used for this,
+so values to be converted are subject to the
+same limitations:
+&ParseFlags; has knowledge of which &consvars; certain
+flags should go to, but not all;
+and only for GCC and compatible compiler chains.
 <parameter>arg</parameter>
-must be a single value,
-so multiple strings must
-be passed in as a list,
-not as separate arguments to
-&f-env-MergeFlags;.
+must be a single object,
+so to pass multiple strings,
+enclose them in a list.
 </para>
 
 <para>
 If <literal>unique</literal> is true (the default),
-duplicate values are not stored.
-When eliminating duplicate values,
-any &consvars; that end with
-the string
+duplicate values are not retained.
+In case of duplication,
+any &consvar; names that end in
 <literal>PATH</literal>
-keep the left-most unique value.
+keep the left-most value so the
+path searcb order is not altered.
 All other &consvars; keep
-the right-most unique value.
+the right-most value.
 If <literal>unique</literal> is false,
-values are added even if they are duplicates.
+values are appended even if they are duplicates.
 </para>
 
 <para>
@@ -2379,14 +2382,14 @@ Examples:
 
 <example_commands>
 # Add an optimization flag to $CCFLAGS.
-env.MergeFlags('-O3')
+env.MergeFlags({'CCFLAGS': '-O3'})
 
 # Combine the flags returned from running pkg-config with an optimization
 # flag and merge the result into the construction variables.
 env.MergeFlags(['!pkg-config gtk+-2.0 --cflags', '-O3'])
 
 # Combine an optimization flag with the flags returned from running pkg-config
-# twice and merge the result into the construction variables.
+# for two distinct packages and merge into the construction variables.
 env.MergeFlags(
     [
         '-O3',

SCons/EnvironmentTests.py

@@ -3177,11 +3177,12 @@ def test_NoClean(self) -> None:
     def test_Dump(self) -> None:
         """Test the Dump() method"""
 
-        env = self.TestEnvironment(FOO = 'foo')
+        env = self.TestEnvironment(FOO='foo', FOOFLAGS=CLVar('--bar --baz'))
         assert env.Dump('FOO') == "'foo'", env.Dump('FOO')
         assert len(env.Dump()) > 200, env.Dump()    # no args version
 
         assert env.Dump('FOO', 'json') == '"foo"'    # JSON key version
+        self.assertEqual(env.Dump('FOOFLAGS', 'json'), '"<<non-serializable: CLVar>>"')
         import json
         env_dict = json.loads(env.Dump(format = 'json'))
         assert env_dict['FOO'] == 'foo'    # full JSON version