Merge pull request #4460 from mwichmann/maint/sconsign

Maint: remove dead code from sconsign

Author: bdbaddog

CHANGES.txt

@@ -72,6 +72,7 @@ RELEASE  VERSION/DATE TO BE FILLED IN LATER
   From Mats Wichmann:
     - Add support for Python 3.13 (as of alpha 2). So far only affects
       expected bytecodes in ActionTests.py.
+    - sconsign cleanup - remove some dead code, minor manpage tweaks.
     - Be more cautious about encodings fetching command output on Windows.
       Problem occurs in piped-spawn scenario, used by Configure tests.
       Fixes #3529.

SCons/Utilities/sconsign.py

@@ -51,24 +51,6 @@ def my_whichdb(filename):
     return whichdb(filename)
 
 
-def my_import(mname):
-    """Import database module.
-
-    This was used if the module was *not* SCons.dblite, to allow
-    for programmatic importing.  It is no longer used, in favor of
-    importlib.import_module, and will be removed eventually.
-    """
-    import imp
-
-    if '.' in mname:
-        i = mname.rfind('.')
-        parent = my_import(mname[:i])
-        fp, pathname, description = imp.find_module(mname[i+1:], parent.__path__)
-    else:
-        fp, pathname, description = imp.find_module(mname)
-    return imp.load_module(mname, fp, pathname, description)
-
-
 class Flagger:
     default_value = 1
 
@@ -449,8 +431,6 @@ def main() -> None:
 
                         dbm = SCons.dblite
                         # Ensure that we don't ignore corrupt DB files,
-                        # this was handled by calling my_import('SCons.dblite')
-                        # again in earlier versions...
                         SCons.dblite.IGNORE_CORRUPT_DBFILES = False
                 except ImportError:
                     sys.stderr.write("sconsign: illegal file format `%s'\n" % a)
@@ -492,8 +472,6 @@ def main() -> None:
 
                     dbm = SCons.dblite
                     # Ensure that we don't ignore corrupt DB files,
-                    # this was handled by calling my_import('SCons.dblite')
-                    # again in earlier versions...
                     SCons.dblite.IGNORE_CORRUPT_DBFILES = False
                 Do_SConsignDB(Map_Module.get(dbm_name, dbm_name), dbm)(a)
             else:

doc/man/sconsign.xml

@@ -1,29 +1,17 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-
-  __COPYRIGHT__
-
-  Permission is hereby granted, free of charge, to any person obtaining
-  a copy of this software and associated documentation files (the
-  "Software"), to deal in the Software without restriction, including
-  without limitation the rights to use, copy, modify, merge, publish,
-  distribute, sublicense, and/or sell copies of the Software, and to
-  permit persons to whom the Software is furnished to do so, subject to
-  the following conditions:
-
-  The above copyright notice and this permission notice shall be included
-  in all copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
-  KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
-  WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
+<!--
+SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
+SPDX-License-Identifier: MIT
 -->
 
+<!DOCTYPE reference [
+<!ENTITY % version SYSTEM "../version.xml">
+%version;
+<!ENTITY % scons SYSTEM '../scons.mod'>
+%scons;
+]>
+
 <refentry id='sconsign1'
           xmlns="http://www.scons.org/dbxsd/v1.0"
           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -48,12 +36,16 @@
 </refsynopsisdiv>
 
 
-<refsect1 id='description'><title>DESCRIPTION</title>
+<refsect1 id='description'>
+<title>DESCRIPTION</title>
 <para>
 Displays the contents of one or more
-<firstterm>sconsign files</firstterm>,
-the signature database files
-used by the <application>SCons</application> build tool.
+<firstterm>sconsign</firstterm> files,
+the signature/dependency database
+used by the &SCons; build tool.
+The database contains all Nodes that are known to the build,
+either by declaration in the build configuration,
+produced as side effects, or detected by inspection.
 </para>
 
 <para>By default,
@@ -64,26 +56,40 @@ Without options,
 individual dependency entries are printed in the following format:</para>
 
 <screen>
-depfile: signature timestamp length
-        implicit_dependency_1: content_signature timestamp length
-        implicit_dependency_2: content_signature timestamp length
+depfile: content-signature timestamp length
+        implicit-dependency-1: content-signature timestamp length
+        implicit-dependency-2: content-signature timestamp length
         ...
-        action_signature [action string]
+        build-signature [action-string]
 </screen>
 
-<para><emphasis role="bold">None</emphasis>
+<para>
+<emphasis role="bold">content-signature</emphasis>
+is the hash of the file's contents (<firstterm>csig</firstterm>)
+and <emphasis role="bold">build-signature</emphasis>
+is the hash of the command line or other build action
+used to build a target (<firstterm>bactsig</firstterm>).
+If provided,
+<emphasis role="bold">action-string</emphasis>
+is the unexpanded string action or the function called.
+<emphasis role="bold">None</emphasis>
 is printed in place of any missing timestamp,
- <firstterm>content signature</firstterm>
-(<emphasis role="bold">csig</emphasis>)
-or
-<firstterm>build action signature</firstterm>
-values for any entry
-or any of its dependencies.
+<emphasis role="bold">csig</emphasis>,
+or <emphasis role="bold">bactsig</emphasis>
+values for any entry or any of its dependencies.
 If the entry has no implicit dependencies,
 or no build action,
-those lines are omitted.</para>
+the corresponding lines are omitted.
+</para>
 
-<para>By default,
+<para>
+An indicator line is printed for each directory,
+as directories do not have signatures in the database
+and so would not otherwise be shown.
+</para>
+
+<para>
+By default,
 <command>sconsign</command>
 assumes that any
 <replaceable>file</replaceable>
@@ -92,14 +98,13 @@ arguments that end with a
 suffix contains
 signature entries for
 more than one directory
-(that is,
-was specified by the
+(that is, was specified by the
 <function>SConsignFile</function>
-function).
+&SCons; function).
 Any
 <replaceable>file</replaceable>
 argument that has no suffix
-is assumed to be an old-style
+is assumed to be an old-style (deprecated)
 sconsign file containing the signature entries
 for a single directory.
 If neither of those is true,
@@ -299,7 +304,8 @@ for all entries or the specified entries.</para>
 <refsect1 id='see_also'>
 <title>SEE ALSO</title>
 <para>
-<command>scons</command>,
+The &SCons; reference (manpage) at
+<ulink url="https://scons.org/doc/production/HTML/scons-man.html"/>,
 the SCons User Guide at
 <ulink url="https://scons.org/doc/production/HTML/scons-user.html"/>,
 the SCons source code