Merge branch 'master' into jbrill-msvc-detect

Author: bdbaddog

.editorconfig

@@ -10,17 +10,17 @@ trim_trailing_whitespace = true
 end_of_line = lf
 charset = utf-8
 
-[*.py]
-max_line_length = 78
+[{*.py,SConstruct,SConscript}]
+max_line_length = 88
 ensure_newline_before_comments = true
 include_trailing_comma = true
 use_parentheses = true
 
-[*.xml]
+[*.{xml,yml,yaml}]
 indent_size = 2
 
 [*.rst]
 indent_size = 3
 
-[*.bat]
+[*.{bat,cmd,ps1}]
 end_of_line = crlf

.git-blame-ignore-revs

@@ -1,2 +1,4 @@
 # files reformatted from DOS line-endings
 1277d8e5ab6457ed18d291100539f31d1bdb2d7c
+# enforced .editorconfig eol settings
+fbb026ef1145fe29e0ec3c1b66a3e99cac51e18d

.gitattributes

@@ -1,7 +1,10 @@
+* text=auto eol=lf
+*.bat eol=crlf
+*.cmd eol=crlf
+*.ps1 eol=crlf
+
 doc/* linguist-documentation
 SCons/Tool/docbook/docbook-xsl-1.76.1 linguist-vendored
 *.xml linguist-documentation
 *.xsl linguist-documentation
 *.gen linguist-documentation
-
-*.in eol=lf

.github/workflows/experimental_tests.yml

@@ -13,6 +13,10 @@ on:
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+env:
+    # for use by the Windows runner (ignored by the others):
+    SCONS_CACHE_MSVC_CONFIG: 1
+
 # A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
   # This workflow contains a single job called "build"
@@ -50,8 +54,8 @@ jobs:
 
       - name: Install dependencies including ninja ${{ matrix.os }}
         run: |
-          python -m pip install --upgrade pip setuptools wheel
-          python -m pip install ninja psutil
+          python -m pip install --progress-bar off --upgrade pip
+          python -m pip install --progress-bar off ninja psutil
           # sudo apt-get update
 
       - name: Test experimental packages ${{ matrix.os }}

.github/workflows/runtest-win.yml

@@ -13,6 +13,9 @@ on:
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
+env:
+    SCONS_CACHE_MSVC_CONFIG: 1
+
 jobs:
   runtest-win32:
     runs-on: windows-latest
@@ -23,11 +26,16 @@ jobs:
         uses: actions/setup-python@v5.1.0
         with:
           python-version: '3.12'
+          cache: 'pip'
+
+      - name: Install Python dependencies
+        run: |
+          python -m pip install --progress-bar off --upgrade pip
+          python -m pip install --progress-bar off -r requirements-dev.txt
 
-      - name: Install dependencies including ninja
+      - name: Install Chocolatey packages
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install -r requirements-dev.txt
+          choco install --yes --no-progress dmd winflexbison3
 
       - name: runtest
         run: |

.github/workflows/runtest.yml

@@ -37,11 +37,12 @@ jobs:
         uses: actions/setup-python@v5.1.0
         with:
           python-version: '3.12'
+          cache: 'pip'
 
-      - name: Install dependencies including ninja ${{ matrix.os }}
+      - name: Install Python dependencies ${{ matrix.os }}
         run: |
-          python -m pip install --upgrade pip setuptools wheel
-          python -m pip install -r requirements-dev.txt
+          python -m pip install --progress-bar off --upgrade pip
+          python -m pip install --progress-bar off -r requirements-dev.txt
           # sudo apt-get update
 
       - name: runtest ${{ matrix.os }}

.github/workflows/scons-package.yml

@@ -20,12 +20,13 @@ jobs:
       uses: actions/setup-python@v5.1.0
       with:
         python-version: '3.12'
+        cache: 'pip'
 
     - name: Install dependencies
       run: |
-        python -m pip install --upgrade pip setuptools wheel build
+        python -m pip install --progress-bar off --upgrade pip setuptools wheel
         #python -m pip install flake8 pytest
-        if [ -f requirements-pkg.txt ]; then pip install -r requirements-pkg.txt; elif [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+        if [ -f requirements-pkg.txt ]; then pip install --progress-bar off -r requirements-pkg.txt; elif [ -f requirements.txt ]; then pip install --progress-bar off -r requirements.txt; fi
         sudo apt-get update
         sudo apt-get -y install docbook-xml docbook-xsl xsltproc fop docbook-xsl-doc-pdf
         # try to keep the texlive install as small as we can to save some time/space

CHANGES.txt

@@ -4,8 +4,11 @@
 
                             Change Log
 
-NOTE: The 4.0.0 Release of SCons dropped Python 2.7 Support
-NOTE: 4.3.0 now requires Python 3.6.0 and above. Python 3.5.x is no longer supported
+NOTE: The 4.0.0 release of SCons dropped Python 2.7 support. Use 3.1.2 if
+  Python 2.7 support is required (but note old SCons releases are unsupported).
+NOTE: Since SCons 4.3.0, Python 3.6.0 or above is required.
+NOTE: Python 3.6 support is deprecated and will be dropped in a future reease.
+  python.org no longer supports 3.6 or 3.7, and will drop 3.8 in Oct. 2024.
 
 RELEASE  VERSION/DATE TO BE FILLED IN LATER
 
@@ -71,6 +74,7 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
     - GetSConsVersion() to grab the latest SCons version without needing to
       access SCons internals.
     - Migrate setup.cfg logic to pyproject.toml; remove setup.cfg.
+    - Update .gitattributes to match .editorconfig; enforce eol settings.
 
   From Raymond Li:
     - Fix issue #3935: OSErrors are now no longer hidden during execution of
@@ -133,6 +137,26 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
     - Framework for scons-time tests adjusted so a path with a long username
       Windows has squashed doesn't get re-expanded. Fixes a problem seen
       on GitHub Windows runner which uses a name "runneradmin".
+    - SCons.Environment.is_valid_construction_var() now returns a boolean to
+      match the convention that functions beginning with "is" have yes/no
+      answers (previously returned either None or an re.match object).
+      Now matches the annotation and docstring (which were prematurely
+      updated in 4.6). All SCons usage except unit test was already fully
+      consistent with a bool.
+    - When a variable is added to a Variables object, it can now be flagged
+      as "don't perform substitution" by setting the argument subst.
+      This allows variables to contain characters which would otherwise
+      cause expansion. Fixes #4241.
+    - The test runner now recognizes the unittest module's return code of 5,
+      which means no tests were run. SCons/Script/MainTests.py currently
+      has no tests, so this particular error code is expected - should not
+      cause runtest to give up with an "unknown error code".
+    - Updated the notes about reproducible builds with SCons and the example.
+    - The Clone() method now respects the variables argument (fixes #3590)
+    - is_valid_construction_var() (not part of the public API) moved from
+      SCons.Environment to SCons.Util to avoid the chance of import loops. Variables
+      and Environment both use the routine and Environment() uses a Variables()
+      object so better to move to a safer location.
 
 
 RELEASE 4.7.0 -  Sun, 17 Mar 2024 17:22:20 -0700

README.rst

@@ -249,6 +249,19 @@ notifications and other GitHub events (``#github-update``),
 if those are of interest. See the website for more contact information:
 https://scons.org/contact.html.
 
+Reproducible Builds
+===================
+SCons itself is set up to do "reproducible builds"
+(see (https://reproducible-builds.org/specs/source-date-epoch/)
+if environment variables ``SOURCE_DATE_EPOCH`` is set - that is,
+fields in the package which could change each time the package is
+constructed are forced to constant values.
+
+To support other projects which wish to do the same, a sample script
+is provided which can be placed in a site directory, which imports
+``SOURCE_DATE_EPOCH`` and sets it in the execution environment of
+every created construction envirionment. There's also an installer
+script (POSIX shell only). See packaging/etc/README.txt for more details.
 
 Donations
 =========
@@ -258,15 +271,6 @@ software, or hardware) to support continued work on the project.  Information
 is available at https://www.scons.org/donate.html
 or the GitHub Sponsors button on https://github.com/scons/scons.
 
-Reproducible Builds
-===================
-In order to suppor those users who which to produce reproducible builds
-(https://reproducible-builds.org/specs/source-date-epoch/) we're now including
-logic to force SCons to propagate SOURCE_DATE_EPOCH from your shell environment for
-all SCons builds to support reproducible builds we're now providing an example
-site_init.py and a script to install it in your ~/.scons. See packaging/etc/README.txt
-for more info
-
 For More Information
 ====================
 

RELEASE.txt

@@ -53,6 +53,15 @@ CHANGED/ENHANCED EXISTING FUNCTIONALITY
 - The vswhere executable locations for the WinGet and Scoop package managers were
   added to the default vswhere executable search list after the Chocolatey
   installation location.
+- SCons.Environment.is_valid_construction_var() now returns a boolean to
+  match the convention that functions beginning with "is" have yes/no
+  answers (previously returned either None or an re.match object).
+  Now matches the annotation and docstring (which were prematurely
+  updated in 4.6). All SCons usage except unit test was already fully
+  consistent with a bool.
+- The Variables object Add method now accepts a subst keyword argument
+  (defaults to True) which can be set to inhibit substitution prior to
+  calling the variable's converter and validator.
 
 FIXES
 -----
@@ -92,6 +101,7 @@ FIXES
   executable that detects new msvc installations.
 - MSVC: Visual Studio 2022 v143 BuildTools now supports msvc toolset versions from
   14.30 to 14.4X.  Fixes Issue #4543.
+- The Clone() method now respects the variables argument (fixes #3590)
 
 IMPROVEMENTS
 ------------
@@ -127,6 +137,7 @@ DOCUMENTATION
 - Restructured API Docs build so main package contents are listed
   before contents of package submodules.
 - Updated manpage description of Command "builder" and function.
+- Updated the notes about reproducible builds with SCons and the example.
 
 
 
@@ -139,7 +150,18 @@ DEVELOPMENT
   by adding SKIP_PDF=1. This should help with distro packaging of SCons,
   which now does not need "fop" and other tools to be set up in order to
   build pdf versions which are then ignored.
-
+- .gitattributes has been setup to mirror .editorconfig's eol settings.
+  The repo-wide line-ending is now `lf`, with the exception of a few
+  Windows-only files using `crlf` instead. Any files not already fitting
+  this format have been explicitly converted.
+- The test runner now recognizes the unittest module's return code of 5,
+  which means no tests were run. SCons/Script/MainTests.py currently
+  has no tests, so this particular error code is expected - should not
+  cause runtest to give up with an "unknown error code".
+- is_valid_construction_var() (not part of the public API) moved from
+  SCons.Environment to SCons.Util to avoid the chance of import loops. Variables
+  and Environment both use the routine and Environment() uses a Variables()
+  object so better to move to a safer location.
 
 Thanks to the following contributors listed below for their contributions to this release.
 ==========================================================================================