summaryrefslogtreecommitdiffstats
path: root/SCons/Conftest.py
diff options
context:
space:
mode:
authorMats Wichmann <mats@linux.com>2020-07-11 14:06:16 (GMT)
committerMats Wichmann <mats@linux.com>2020-09-23 18:31:48 (GMT)
commitd0a3e4ed38f4a4cd84000dec2342f51b6dda69b9 (patch)
tree69968f37fe9a8d41ff23205f66468003956dfff2 /SCons/Conftest.py
parentea642040eca864aaeac25da013cce9fd875489f0 (diff)
downloadSCons-d0a3e4ed38f4a4cd84000dec2342f51b6dda69b9.zip
SCons-d0a3e4ed38f4a4cd84000dec2342f51b6dda69b9.tar.gz
SCons-d0a3e4ed38f4a4cd84000dec2342f51b6dda69b9.tar.bz2
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 <mats@linux.com>
Diffstat (limited to 'SCons/Conftest.py')
-rw-r--r--SCons/Conftest.py145
1 files changed, 67 insertions, 78 deletions
diff --git a/SCons/Conftest.py b/SCons/Conftest.py
index 4491884..ec40902 100644
--- a/SCons/Conftest.py
+++ b/SCons/Conftest.py
@@ -1,9 +1,6 @@
-"""SCons.Conftest
-
-Autoconf-like configuration support; low level implementation of tests.
-"""
-
+# MIT License
#
+# Copyright The SCons Foundation
# Copyright (c) 2003 Stichting NLnet Labs
# Copyright (c) 2001, 2002, 2003 Steven Knight
#
@@ -25,80 +22,72 @@ Autoconf-like configuration support; low level implementation of tests.
# 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.
-#
-#
-# The purpose of this module is to define how a check is to be performed.
-# Use one of the Check...() functions below.
-#
-
-#
-# A context class is used that defines functions for carrying out the tests,
-# logging and messages. The following methods and members must be present:
-#
-# context.Display(msg) Function called to print messages that are normally
-# displayed for the user. Newlines are explicitly used.
-# The text should also be written to the logfile!
-#
-# context.Log(msg) Function called to write to a log file.
-#
-# context.BuildProg(text, ext)
-# Function called to build a program, using "ext" for the
-# file extention. Must return an empty string for
-# success, an error message for failure.
-# For reliable test results building should be done just
-# like an actual program would be build, using the same
-# command and arguments (including configure results so
-# far).
-#
-# context.CompileProg(text, ext)
-# Function called to compile a program, using "ext" for
-# the file extention. Must return an empty string for
-# success, an error message for failure.
-# For reliable test results compiling should be done just
-# like an actual source file would be compiled, using the
-# same command and arguments (including configure results
-# so far).
-#
-# context.AppendLIBS(lib_name_list)
-# Append "lib_name_list" to the value of LIBS.
-# "lib_namelist" is a list of strings.
-# Return the value of LIBS before changing it (any type
-# can be used, it is passed to SetLIBS() later.)
-#
-# context.PrependLIBS(lib_name_list)
-# Prepend "lib_name_list" to the value of LIBS.
-# "lib_namelist" is a list of strings.
-# Return the value of LIBS before changing it (any type
-# can be used, it is passed to SetLIBS() later.)
-#
-# context.SetLIBS(value)
-# Set LIBS to "value". The type of "value" is what
-# AppendLIBS() returned.
-# Return the value of LIBS before changing it (any type
-# can be used, it is passed to SetLIBS() later.)
-#
-# context.headerfilename
-# Name of file to append configure results to, usually
-# "confdefs.h".
-# The file must not exist or be empty when starting.
-# Empty or None to skip this (some tests will not work!).
-#
-# context.config_h (may be missing). If present, must be a string, which
-# will be filled with the contents of a config_h file.
-#
-# context.vardict Dictionary holding variables used for the tests and
-# stores results from the tests, used for the build
-# commands.
-# Normally contains "CC", "LIBS", "CPPFLAGS", etc.
-#
-# context.havedict Dictionary holding results from the tests that are to
-# be used inside a program.
-# Names often start with "HAVE_". These are zero
-# (feature not present) or one (feature present). Other
-# variables may have any value, e.g., "PERLVERSION" can
-# be a number and "SYSTEMNAME" a string.
-#
+"""Autoconf-like configuration support
+
+The purpose of this module is to define how a check is to be performed.
+
+A context class is used that defines functions for carrying out the tests,
+logging and messages. The following methods and members must be present:
+
+context.Display(msg)
+ Function called to print messages that are normally displayed
+ for the user. Newlines are explicitly used. The text should
+ also be written to the logfile!
+
+context.Log(msg)
+ Function called to write to a log file.
+
+context.BuildProg(text, ext)
+ Function called to build a program, using "ext" for the file
+ extention. Must return an empty string for success, an error
+ message for failure. For reliable test results building should
+ be done just like an actual program would be build, using the
+ same command and arguments (including configure results so far).
+
+context.CompileProg(text, ext)
+ Function called to compile a program, using "ext" for the file
+ extention. Must return an empty string for success, an error
+ message for failure. For reliable test results compiling should be
+ done just like an actual source file would be compiled, using the
+ same command and arguments (including configure results so far).
+
+context.AppendLIBS(lib_name_list)
+ Append "lib_name_list" to the value of LIBS. "lib_namelist" is
+ a list of strings. Return the value of LIBS before changing it
+ (any type can be used, it is passed to SetLIBS() later.)
+
+context.PrependLIBS(lib_name_list)
+ Prepend "lib_name_list" to the value of LIBS. "lib_namelist" is
+ a list of strings. Return the value of LIBS before changing it
+ (any type can be used, it is passed to SetLIBS() later.)
+
+context.SetLIBS(value)
+ Set LIBS to "value". The type of "value" is what AppendLIBS()
+ returned. Return the value of LIBS before changing it (any type
+ can be used, it is passed to SetLIBS() later.)
+
+context.headerfilename
+ Name of file to append configure results to, usually "confdefs.h".
+ The file must not exist or be empty when starting. Empty or None
+ to skip this (some tests will not work!).
+
+context.config_h (may be missing).
+ If present, must be a string, which will be filled with the
+ contents of a config_h file.
+
+context.vardict
+ Dictionary holding variables used for the tests and stores results
+ from the tests, used for the build commands. Normally contains
+ "CC", "LIBS", "CPPFLAGS", etc.
+
+context.havedict
+ Dictionary holding results from the tests that are to be used
+ inside a program. Names often start with "HAVE_". These are zero
+ (feature not present) or one (feature present). Other variables
+ may have any value, e.g., "PERLVERSION" can be a number and
+ "SYSTEMNAME" a string.
+"""
import re