From d0a3e4ed38f4a4cd84000dec2342f51b6dda69b9 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sat, 11 Jul 2020 08:06:16 -0600 Subject: Update some copyright strings and drop __revision__ [skip appveyor] Touches the first and second levels of SCons (except SCons.Tool), not tests or docs which remain TODO. Make sure docstring is first non-comment content, eliminate cases where docstring is set elsewhere but assigns to __doc__ - this approach of course worked inside Python, but confuses various tools. Some module-level docstrings modified a bit, in particular the convention of having the name of the module as the first line is dropped, replaced by a summary description going there instead - this improves the look in the API Docs, which otherwise display something like: SCons.Foo - SCons.Foo Signed-off-by: Mats Wichmann --- SCons/Action.py | 54 +++++----- SCons/Action.xml | 2 +- SCons/ActionTests.py | 7 +- SCons/Builder.py | 47 +++++---- SCons/BuilderTests.py | 5 +- SCons/CacheDir.py | 9 +- SCons/CacheDirTests.py | 6 +- SCons/Conftest.py | 145 +++++++++++++-------------- SCons/Debug.py | 22 ++--- SCons/Defaults.py | 28 +++--- SCons/Defaults.xml | 2 +- SCons/DefaultsTests.py | 6 +- SCons/Environment.py | 22 ++--- SCons/Environment.xml | 2 +- SCons/EnvironmentTests.py | 5 +- SCons/EnvironmentValues.py | 23 +++++ SCons/EnvironmentValuesTest.py | 23 +++++ SCons/Errors.py | 11 +-- SCons/ErrorsTests.py | 6 +- SCons/Executor.py | 13 +-- SCons/ExecutorTests.py | 6 +- SCons/Job.py | 18 ++-- SCons/JobTests.py | 5 +- SCons/Memoize.py | 7 +- SCons/MemoizeTests.py | 6 +- SCons/Node/Alias.py | 18 ++-- SCons/Node/AliasTests.py | 6 +- SCons/Node/FS.py | 29 +++--- SCons/Node/FSTests.py | 6 +- SCons/Node/NodeTests.py | 5 +- SCons/Node/Python.py | 12 +-- SCons/Node/PythonTests.py | 6 +- SCons/Node/__init__.py | 43 ++++---- SCons/PathList.py | 17 ++-- SCons/PathListTests.py | 6 +- SCons/Platform/Platform.xml | 2 +- SCons/Platform/PlatformTests.py | 7 +- SCons/Platform/__init__.py | 42 ++++---- SCons/Platform/aix.py | 20 ++-- SCons/Platform/cygwin.py | 20 ++-- SCons/Platform/darwin.py | 20 ++-- SCons/Platform/hpux.py | 20 ++-- SCons/Platform/irix.py | 20 ++-- SCons/Platform/mingw.py | 14 +-- SCons/Platform/os2.py | 21 ++-- SCons/Platform/posix.py | 20 ++-- SCons/Platform/posix.xml | 2 +- SCons/Platform/sunos.py | 20 ++-- SCons/Platform/sunos.xml | 2 +- SCons/Platform/virtualenv.py | 15 +-- SCons/Platform/virtualenvTests.py | 9 +- SCons/Platform/win32.py | 20 ++-- SCons/Platform/win32.xml | 2 +- SCons/SConf.py | 28 +++--- SCons/SConfTests.py | 6 +- SCons/SConsign.py | 13 +-- SCons/SConsignTests.py | 6 +- SCons/Scanner/C.py | 35 +++---- SCons/Scanner/CTests.py | 9 +- SCons/Scanner/D.py | 18 ++-- SCons/Scanner/DTests.py | 10 +- SCons/Scanner/Dir.py | 5 +- SCons/Scanner/DirTests.py | 6 +- SCons/Scanner/Fortran.py | 11 +-- SCons/Scanner/FortranTests.py | 7 +- SCons/Scanner/IDL.py | 23 ++--- SCons/Scanner/IDLTests.py | 6 +- SCons/Scanner/LaTeX.py | 18 ++-- SCons/Scanner/LaTeXTests.py | 9 +- SCons/Scanner/Prog.py | 16 ++- SCons/Scanner/ProgTests.py | 6 +- SCons/Scanner/Python.py | 31 +++--- SCons/Scanner/PythonTests.py | 6 +- SCons/Scanner/RC.py | 38 +++----- SCons/Scanner/RCTests.py | 6 +- SCons/Scanner/SWIG.py | 12 +-- SCons/Scanner/Scanner.xml | 2 +- SCons/Scanner/ScannerTests.py | 8 +- SCons/Scanner/__init__.py | 168 ++++++++++++++++---------------- SCons/Script/Interactive.py | 8 +- SCons/Script/Main.py | 33 +++---- SCons/Script/Main.xml | 2 +- SCons/Script/MainTests.py | 6 +- SCons/Script/SConsOptions.py | 6 +- SCons/Script/SConscript.py | 12 +-- SCons/Script/SConscript.xml | 2 +- SCons/Script/SConscriptTests.py | 6 +- SCons/Script/__init__.py | 34 +++---- SCons/Subst.py | 24 ++--- SCons/Subst.xml | 2 +- SCons/SubstTests.py | 5 +- SCons/Taskmaster.py | 57 +++++------ SCons/TaskmasterTests.py | 5 +- SCons/Util.py | 12 +-- SCons/UtilTests.py | 6 +- SCons/Utilities/ConfigureCache.py | 6 +- SCons/Utilities/sconsign.py | 6 +- SCons/Variables/BoolVariable.py | 28 +++--- SCons/Variables/BoolVariableTests.py | 6 +- SCons/Variables/EnumVariable.py | 44 +++++---- SCons/Variables/EnumVariableTests.py | 6 +- SCons/Variables/ListVariable.py | 59 +++++------ SCons/Variables/ListVariableTests.py | 6 +- SCons/Variables/PackageVariable.py | 54 +++++----- SCons/Variables/PackageVariableTests.py | 6 +- SCons/Variables/PathVariable.py | 78 +++++++-------- SCons/Variables/PathVariableTests.py | 6 +- SCons/Variables/VariablesTests.py | 6 +- SCons/Variables/__init__.py | 11 +-- SCons/Warnings.py | 12 +-- SCons/WarningsTests.py | 6 +- SCons/__main__.py | 23 +++++ SCons/compat/__init__.py | 19 ++-- SCons/compat/_scons_dbm.py | 9 +- SCons/cpp.py | 11 +-- SCons/cppTests.py | 6 +- SCons/dblite.py | 23 +++++ SCons/exitfuncs.py | 13 +-- 118 files changed, 926 insertions(+), 1145 deletions(-) diff --git a/SCons/Action.py b/SCons/Action.py index 1f499ee..d7f10df 100644 --- a/SCons/Action.py +++ b/SCons/Action.py @@ -1,11 +1,34 @@ -"""SCons.Action +# MIT License +# +# Copyright The SCons Foundation +# +# 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. + +"""SCons Actions. -This encapsulates information about executing any sort of action that +Information about executing any sort of action that can build one or more target Nodes (typically files) from one or more source Nodes (also typically files) given a specific Environment. The base class here is ActionBase. The base class supplies just a few -OO utility methods and some generic methods for displaying information +utility methods and some generic methods for displaying information about an Action in response to the various commands that control printing. A second-level base class is _ActionAction. This extends ActionBase @@ -60,7 +83,7 @@ this module: get_presig() Fetches the "contents" of a subclass for signature calculation. The varlist is added to this to produce the Action's contents. - TODO(?): Change this to always return ascii/bytes and not unicode (or py3 strings) + TODO(?): Change this to always return bytes and not str? strfunction() Returns a substituted string representation of the Action. @@ -77,29 +100,6 @@ way for wrapping up the functions. """ -# __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. - -__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__" - import os import pickle import re diff --git a/SCons/Action.xml b/SCons/Action.xml index 8263a57..0e3ef33 100644 --- a/SCons/Action.xml +++ b/SCons/Action.xml @@ -1,6 +1,6 @@