"Fossies" - the Fresh Open Source Software Archive  

Source code changes of the file "scons.1" between
scons-3.0.4.tar.gz and scons-3.0.5.tar.gz

About: SCons is a software construction tool (a Python script and a set of modules as a superior alternative to the classic "Make" build tool).

scons.1  (scons-3.0.4):scons.1  (scons-3.0.5)
SCONS(1) SCons 3.0.4 SCONS(1) SCONS(1) SCons 3.0.5 SCONS(1)
NAME NAME
scons - a software construction tool scons - a software construction tool
SYNOPSIS SYNOPSIS
scons [options...] [name=val...] [targets...] scons [options...] [name=val...] [targets...]
DESCRIPTION DESCRIPTION
The scons utility builds software (or other files) by determining which c omponent pieces must be rebuilt The scons utility builds software (or other files) by determining which c omponent pieces must be rebuilt
and executing the necessary commands to rebuild them. and executing the necessary commands to rebuild them.
skipping to change at line 91 skipping to change at line 91
BitKeeper. BitKeeper.
scons is normally executed in a top-level directory containing a SConstru ct file, optionally specifying scons is normally executed in a top-level directory containing a SConstru ct file, optionally specifying
as command-line arguments the target file or files to be built. as command-line arguments the target file or files to be built.
By default, the command By default, the command
scons scons
will build all target files in or below the current directory. Explicit d efault targets (to be built will build all target files in or below the current directory. Explicit d efault targets (to be built
when no targets are specified on the command line) may be defined the SCo nscript file(s) using the when no targets are specified on the command line) may be defined in the SConscript file(s) using the
Default() function, described below. Default() function, described below.
Even when Default() targets are specified in the SConscript file(s), all target files in or below the Even when Default() targets are specified in the SConscript file(s), all target files in or below the
current directory may be built by explicitly specifying the current direc tory (.) as a command-line current directory may be built by explicitly specifying the current direc tory (.) as a command-line
target: target:
scons . scons .
Building all target files, including any files outside of the current dir ectory, may be specified by Building all target files, including any files outside of the current dir ectory, may be specified by
supplying a command-line target of the root directory (on POSIX systems): supplying a command-line target of the root directory (on POSIX systems):
skipping to change at line 1335 skipping to change at line 1335
Sets: $DC, $DCOM, $DDEBUG, $DDEBUGPREFIX, $DDEBUGSUFFIX, $DFILESUFFIX , $DFLAGPREFIX, $DFLAGS, Sets: $DC, $DCOM, $DDEBUG, $DDEBUGPREFIX, $DDEBUGSUFFIX, $DFILESUFFIX , $DFLAGPREFIX, $DFLAGS,
$DFLAGSUFFIX, $DINCPREFIX, $DINCSUFFIX, $DLIB, $DLIBCOM, $DLIBDIRPREF IX, $DLIBDIRSUFFIX, $DFLAGSUFFIX, $DINCPREFIX, $DINCSUFFIX, $DLIB, $DLIBCOM, $DLIBDIRPREF IX, $DLIBDIRSUFFIX,
$DLIBFLAGPREFIX, $DLIBFLAGSUFFIX, $DLIBLINKPREFIX, $DLIBLINKSUFFIX, $ DLINK, $DLINKCOM, $DLIBFLAGPREFIX, $DLIBFLAGSUFFIX, $DLIBLINKPREFIX, $DLIBLINKSUFFIX, $ DLINK, $DLINKCOM,
$DLINKFLAGPREFIX, $DLINKFLAGS, $DLINKFLAGSUFFIX, $DPATH, $DRPATHPREFI X, $DRPATHSUFFIX, $DLINKFLAGPREFIX, $DLINKFLAGS, $DLINKFLAGSUFFIX, $DPATH, $DRPATHPREFI X, $DRPATHSUFFIX,
$DShLibSonameGenerator, $DVERPREFIX, $DVERSIONS, $DVERSUFFIX, $SHDC, $SHDCOM, $SHDLIBVERSION, $DShLibSonameGenerator, $DVERPREFIX, $DVERSIONS, $DVERSUFFIX, $SHDC, $SHDCOM, $SHDLIBVERSION,
$SHDLIBVERSIONFLAGS, $SHDLINK, $SHDLINKCOM, $SHDLINKFLAGS. $SHDLIBVERSIONFLAGS, $SHDLINK, $SHDLINKCOM, $SHDLINKFLAGS.
lex lex
Sets construction variables for the lex lexical analyser. Sets construction variables for the lex lexical analyser.
Sets: $LEX, $LEXCOM, $LEXFLAGS. Sets: $LEX, $LEXCOM, $LEXFLAGS, $LEXUNISTD.
Uses: $LEXCOMSTR. Uses: $LEXCOMSTR.
link link
Sets construction variables for generic POSIX linkers. Sets construction variables for generic POSIX linkers.
Sets: $LDMODULE, $LDMODULECOM, $LDMODULEFLAGS, $LDMODULENOVERSIONSYML INKS, $LDMODULEPREFIX, Sets: $LDMODULE, $LDMODULECOM, $LDMODULEFLAGS, $LDMODULENOVERSIONSYML INKS, $LDMODULEPREFIX,
$LDMODULESUFFIX, $LDMODULEVERSION, $LDMODULEVERSIONFLAGS, $LIBDIRPREF IX, $LIBDIRSUFFIX, $LDMODULESUFFIX, $LDMODULEVERSION, $LDMODULEVERSIONFLAGS, $LIBDIRPREF IX, $LIBDIRSUFFIX,
$LIBLINKPREFIX, $LIBLINKSUFFIX, $LINK, $LINKCOM, $LINKFLAGS, $SHLIBSU FFIX, $SHLINK, $SHLINKCOM, $LIBLINKPREFIX, $LIBLINKSUFFIX, $LINK, $LINKCOM, $LINKFLAGS, $SHLIBSU FFIX, $SHLINK, $SHLINKCOM,
$SHLINKFLAGS, $__LDMODULEVERSIONFLAGS, $__SHLIBVERSIONFLAGS. $SHLINKFLAGS, $__LDMODULEVERSIONFLAGS, $__SHLIBVERSIONFLAGS.
skipping to change at line 1676 skipping to change at line 1676
env.Program('bar', ['bar.c', 'foo.c']) env.Program('bar', ['bar.c', 'foo.c'])
env.Program('bar', Split('bar.c foo.c')) env.Program('bar', Split('bar.c foo.c'))
env.Program('bar', env.Split('bar.c foo.c')) env.Program('bar', env.Split('bar.c foo.c'))
env.Program(source = ['bar.c', 'foo.c'], target = 'bar') env.Program(source = ['bar.c', 'foo.c'], target = 'bar')
env.Program(target = 'bar', Split('bar.c foo.c')) env.Program(target = 'bar', Split('bar.c foo.c'))
env.Program(target = 'bar', env.Split('bar.c foo.c')) env.Program(target = 'bar', env.Split('bar.c foo.c'))
env.Program('bar', source = 'bar.c foo.c'.split()) env.Program('bar', source = 'bar.c foo.c'.split())
Target and source file names that are not absolute path names (that is, d o not begin with / on POSIX Target and source file names that are not absolute path names (that is, d o not begin with / on POSIX
systems or \fR on Windows systems, with or without an optional drive lett er) are interpreted relative to systems or \ on Windows systems, with or without an optional drive letter ) are interpreted relative to
the directory containing the SConscript file being read. An initial # (ha sh mark) on a path name means the directory containing the SConscript file being read. An initial # (ha sh mark) on a path name means
that the rest of the file name is interpreted relative to the directory c ontaining the top-level that the rest of the file name is interpreted relative to the directory c ontaining the top-level
SConstruct file, even if the # is followed by a directory separator chara cter (slash or backslash). SConstruct file, even if the # is followed by a directory separator chara cter (slash or backslash).
Examples: Examples:
# The comments describing the targets that will be built # The comments describing the targets that will be built
# assume these calls are in a SConscript file in the # assume these calls are in a SConscript file in the
# a subdirectory named "subdir". # a subdirectory named "subdir".
skipping to change at line 2246 skipping to change at line 2246
path name of any files that cause compilation errors. path name of any files that cause compilation errors.
Example usage: Example usage:
barsrcs = ['bar.cpp'] barsrcs = ['bar.cpp']
barincs = ['bar.h'] barincs = ['bar.h']
barlocalincs = ['StdAfx.h'] barlocalincs = ['StdAfx.h']
barresources = ['bar.rc','resource.h'] barresources = ['bar.rc','resource.h']
barmisc = ['bar_readme.txt'] barmisc = ['bar_readme.txt']
dll = env.SharedLibrary(target = 'bar.dll', dll = env.SharedLibrary(target='bar.dll',
source = barsrcs) source=barsrcs)
buildtarget = [s for s in dll if str(s).endswith('dll')] buildtarget = [s for s in dll if str(s).endswith('dll')]
env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'],
srcs = barsrcs, srcs=barsrcs,
incs = barincs, incs=barincs,
localincs = barlocalincs, localincs=barlocalincs,
resources = barresources, resources=barresources,
misc = barmisc, misc=barmisc,
buildtarget = buildtarget, buildtarget=buildtarget,
variant = 'Release') variant='Release')
Starting with version 2.4 of SCons it's also possible to specify the optional argument Starting with version 2.4 of SCons it is also possible to specify the optional argument
DebugSettings, which creates files for debugging under Visual Studio: DebugSettings, which creates files for debugging under Visual Studio:
DebugSettings DebugSettings
A dictionary of debug settings that get written to the .vcproj.us er or the .vcxproj.user file, A dictionary of debug settings that get written to the .vcproj.us er or the .vcxproj.user file,
depending on the version installed. As it is done for cmdargs (se e above), you can specify a depending on the version installed. As it is done for cmdargs (se e above), you can specify a
DebugSettings dictionary per variant. If you give only one, it wi ll be propagated to all DebugSettings dictionary per variant. If you give only one, it wi ll be propagated to all
variants. variants.
Currently, only Visual Studio v9.0 and Visual Studio version v11 are implemented, for other versions Currently, only Visual Studio v9.0 and Visual Studio version v11 are implemented, for other versions
no file is generated. To generate the user file, you just need to add a DebugSettings dictionary to no file is generated. To generate the user file, you just need to add a DebugSettings dictionary to
skipping to change at line 2375 skipping to change at line 2375
# #
# 4. Add the dictionary to the DebugSettings keyword. # 4. Add the dictionary to the DebugSettings keyword.
# #
barsrcs = ['bar.cpp', 'dllmain.cpp', 'stdafx.cpp'] barsrcs = ['bar.cpp', 'dllmain.cpp', 'stdafx.cpp']
barincs = ['targetver.h'] barincs = ['targetver.h']
barlocalincs = ['StdAfx.h'] barlocalincs = ['StdAfx.h']
barresources = ['bar.rc','resource.h'] barresources = ['bar.rc','resource.h']
barmisc = ['ReadMe.txt'] barmisc = ['ReadMe.txt']
dll = env.SharedLibrary(target = 'bar.dll', dll = env.SharedLibrary(target='bar.dll',
source = barsrcs) source=barsrcs)
env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'],
srcs = barsrcs, srcs=barsrcs,
incs = barincs, incs=barincs,
localincs = barlocalincs, localincs=barlocalincs,
resources = barresources, resources=barresources,
misc = barmisc, misc=barmisc,
buildtarget = [dll[0]] * 2, buildtarget=[dll[0]] * 2,
variant = ('Debug|Win32', 'Release|Win32'), variant=('Debug|Win32', 'Release|Win32'),
cmdargs = 'vc=%s' % msvcver, cmdargs='vc=%s' % msvcver,
DebugSettings = (dbgSettings, {})) DebugSettings=(dbgSettings, {}))
MSVSSolution(), env.MSVSSolution() MSVSSolution(), env.MSVSSolution()
Builds a Microsoft Visual Studio solution file. Builds a Microsoft Visual Studio solution file.
This builds a Visual Studio solution file, based on the version of Vi sual Studio that is configured This builds a Visual Studio solution file, based on the version of Vi sual Studio that is configured
(either the latest installed version, or the version specified by $MS VS_VERSION in the construction (either the latest installed version, or the version specified by $MS VS_VERSION in the construction
environment). For Visual Studio 6, it will generate a .dsw file. For Visual Studio 7 (.NET), it will environment). For Visual Studio 6, it will generate a .dsw file. For Visual Studio 7 (.NET), it will
generate a .sln file. generate a .sln file.
The following values must be specified: The following values must be specified:
skipping to change at line 2419 skipping to change at line 2419
projects projects
A list of project file names, or Project nodes returned by calls to the MSVSProject Builder, to A list of project file names, or Project nodes returned by calls to the MSVSProject Builder, to
be placed into the solution file. It should be noted that these f ile names are NOT added to the be placed into the solution file. It should be noted that these f ile names are NOT added to the
$SOURCES environment variable in form of files, but rather as str ings. This is because they $SOURCES environment variable in form of files, but rather as str ings. This is because they
represent file names to be added to the solution file, not the so urce files used to build the represent file names to be added to the solution file, not the so urce files used to build the
solution file. solution file.
Example Usage: Example Usage:
env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], proj env.MSVSSolution(target='Bar' + env['MSVSSOLUTIONSUFFIX'], projec
ects = ['bar' ts=['bar' + env['MSVSPROJECTSUFFIX']], variant='Release')
+ env['MSVSPROJECTSUFFIX']], variant = 'Release')
Object(), env.Object() Object(), env.Object()
A synonym for the StaticObject builder method. A synonym for the StaticObject builder method.
Package(), env.Package() Package(), env.Package()
Builds a Binary Package of the given source files. Builds a Binary Package of the given source files.
env.Package(source = FindInstalledFiles()) env.Package(source = FindInstalledFiles())
Builds software distribution packages. Packages consist of files to i nstall and packaging Builds software distribution packages. Packages consist of files to i nstall and packaging
skipping to change at line 2967 skipping to change at line 2966
If a construction variable named $SUBST_DICT is present, it may be ei ther a Python dictionary or a If a construction variable named $SUBST_DICT is present, it may be ei ther a Python dictionary or a
sequence of (key,value) tuples. If it is a dictionary it is converted into a list of tuples in an sequence of (key,value) tuples. If it is a dictionary it is converted into a list of tuples in an
arbitrary order, so if one key is a prefix of another key or if one s ubstitution could be further arbitrary order, so if one key is a prefix of another key or if one s ubstitution could be further
expanded by another subsitition, it is unpredictable whether the expa nsion will occur. expanded by another subsitition, it is unpredictable whether the expa nsion will occur.
Any occurrences of a key in the source are replaced by the correspond ing value, which may be a Any occurrences of a key in the source are replaced by the correspond ing value, which may be a
Python callable function or a string. If the value is a callable, it is called with no arguments to Python callable function or a string. If the value is a callable, it is called with no arguments to
get a string. Strings are subst-expanded and the result replaces the key. get a string. Strings are subst-expanded and the result replaces the key.
env = Environment(tools = ['default', 'textfile']) env = Environment(tools=['default'])
env['prefix'] = '/usr/bin' env['prefix'] = '/usr/bin'
script_dict = {'@prefix@': '/bin', '@exec_prefix@': '$prefix'} script_dict = {'@prefix@': '/bin', '@exec_prefix@': '$prefix'}
env.Substfile('script.in', SUBST_DICT = script_dict) env.Substfile('script.in', SUBST_DICT = script_dict)
conf_dict = {'%VERSION%': '1.2.3', '%BASE%': 'MyProg'} conf_dict = {'%VERSION%': '1.2.3', '%BASE%': 'MyProg'}
env.Substfile('config.h.in', conf_dict, SUBST_DICT = conf_dict) env.Substfile('config.h.in', conf_dict, SUBST_DICT = conf_dict)
# UNPREDICTABLE - one key is a prefix of another # UNPREDICTABLE - one key is a prefix of another
bad_foo = {'$foo': '$foo', '$foobar': '$foobar'} bad_foo = {'$foo': '$foo', '$foobar': '$foobar'}
skipping to change at line 2994 skipping to change at line 2993
# UNPREDICTABLE - one substitution could be futher expanded # UNPREDICTABLE - one substitution could be futher expanded
bad_bar = {'@bar@': '@soap@', '@soap@': 'lye'} bad_bar = {'@bar@': '@soap@', '@soap@': 'lye'}
env.Substfile('bar.in', SUBST_DICT = bad_bar) env.Substfile('bar.in', SUBST_DICT = bad_bar)
# PREDICTABLE - substitutions are expanded in order # PREDICTABLE - substitutions are expanded in order
good_bar = (('@bar@', '@soap@'), ('@soap@', 'lye')) good_bar = (('@bar@', '@soap@'), ('@soap@', 'lye'))
env.Substfile('bar.in', SUBST_DICT = good_bar) env.Substfile('bar.in', SUBST_DICT = good_bar)
# the SUBST_DICT may be in common (and not an override) # the SUBST_DICT may be in common (and not an override)
substutions = {} substutions = {}
subst = Environment(tools = ['textfile'], SUBST_DICT = substituti ons) subst = Environment(tools=['textfile'], SUBST_DICT=substitutions)
substitutions['@foo@'] = 'foo' substitutions['@foo@'] = 'foo'
subst['SUBST_DICT']['@bar@'] = 'bar' subst['SUBST_DICT']['@bar@'] = 'bar'
subst.Substfile('pgm1.c', [Value('#include "@foo@.h"'), subst.Substfile('pgm1.c', [Value('#include "@foo@.h"'),
Value('#include "@bar@.h"'), Value('#include "@bar@.h"'),
"common.in", "common.in",
"pgm1.in" "pgm1.in"
]) ])
subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'), subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'),
Value('#include "@bar@.h"'), Value('#include "@bar@.h"'),
"common.in", "common.in",
skipping to change at line 3664 skipping to change at line 3663
Example: Example:
def my_decider(dependency, target, prev_ni): def my_decider(dependency, target, prev_ni):
return not os.path.exists(str(target)) return not os.path.exists(str(target))
env.Decider(my_decider) env.Decider(my_decider)
Default(targets), env.Default(targets) Default(targets), env.Default(targets)
This specifies a list of default targets, which will be built by scon s if no explicit targets are This specifies a list of default targets, which will be built by scon s if no explicit targets are
given on the command line. Multiple calls to Default are legal, and a dd to the list of default given on the command line. Multiple calls to Default are legal, and a dd to the list of default
targets. targets. As noted above, both forms of this call affect the same glob
al list of default targets; the
construction environment method applies construction variable expansi
on to the targets.
Multiple targets should be specified as separate arguments to the Def ault method, or as a list. Multiple targets should be specified as separate arguments to the Def ault method, or as a list.
Default will also accept the Node returned by any of a construction e nvironment's builder methods. Default will also accept the Node returned by any of a construction e nvironment's builder methods.
Examples: Examples:
Default('foo', 'bar', 'baz') Default('foo', 'bar', 'baz')
env.Default(['a', 'b', 'c']) env.Default(['a', 'b', 'c'])
hello = env.Program('hello', 'hello.c') hello = env.Program('hello', 'hello.c')
env.Default(hello) env.Default(hello)
skipping to change at line 6659 skipping to change at line 6659
LEXCOMSTR LEXCOMSTR
The string displayed when generating a source file using the lexical analyzer generator. If this is The string displayed when generating a source file using the lexical analyzer generator. If this is
not set, then $LEXCOM (the command line) is displayed. not set, then $LEXCOM (the command line) is displayed.
env = Environment(LEXCOMSTR = "Lex'ing $TARGET from $SOURCES") env = Environment(LEXCOMSTR = "Lex'ing $TARGET from $SOURCES")
LEXFLAGS LEXFLAGS
General options passed to the lexical analyzer generator. General options passed to the lexical analyzer generator.
LEXUNISTD
Used only on windows environments to set a lex flag to prevent 'unist
d.h' from being included. The
default value is '--nounistd'.
_LIBDIRFLAGS _LIBDIRFLAGS
An automatically-generated construction variable containing the linke r command-line options for An automatically-generated construction variable containing the linke r command-line options for
specifying directories to be searched for library. The value of $_LIB DIRFLAGS is created by specifying directories to be searched for library. The value of $_LIB DIRFLAGS is created by
respectively prepending and appending $LIBDIRPREFIX and $LIBDIRSUFFIX to the beginning and end of respectively prepending and appending $LIBDIRPREFIX and $LIBDIRSUFFIX to the beginning and end of
each directory in $LIBPATH. each directory in $LIBPATH.
LIBDIRPREFIX LIBDIRPREFIX
The prefix used to specify a library directory on the linker command line. This will be prepended to The prefix used to specify a library directory on the linker command line. This will be prepended to
the beginning of each directory in the $LIBPATH construction variable when the $_LIBDIRFLAGS the beginning of each directory in the $LIBPATH construction variable when the $_LIBDIRFLAGS
variable is automatically generated. variable is automatically generated.
skipping to change at line 6972 skipping to change at line 6976
installed location of the .NET SDK. installed location of the .NET SDK.
PLATFORMSDKDIR PLATFORMSDKDIR
installed location of the Platform SDK. installed location of the Platform SDK.
PLATFORMSDK_MODULES PLATFORMSDK_MODULES
dictionary of installed Platform SDK modules, where the dictionar y keys are keywords for the dictionary of installed Platform SDK modules, where the dictionar y keys are keywords for the
various modules, and the values are 2-tuples where the first is t he release date, and the second various modules, and the values are 2-tuples where the first is t he release date, and the second
is the version number. is the version number.
If a value isn't set, it wasn't available in the registry. If a value is not set, it was not available in the registry.
MSVS_ARCH MSVS_ARCH
Sets the architecture for which the generated project(s) should build . Sets the architecture for which the generated project(s) should build .
The default value is x86. amd64 is also supported by SCons for some The default value is x86. amd64 is also supported by SCons for most
Visual Studio versions. Trying Visual Studio versions. Since
to set $MSVS_ARCH to an architecture that's not supported for a given Visual Studio 2015 arm is supported, and since Visual Studio 2017 arm
Visual Studio version will 64 is supported. Trying to set
generate an error. $MSVS_ARCH to an architecture that's not supported for a given Visual
Studio version will generate
an error.
MSVS_PROJECT_GUID MSVS_PROJECT_GUID
The string placed in a generated Microsoft Visual Studio project file as the value of the The string placed in a generated Microsoft Visual Studio project file as the value of the
ProjectGUID attribute. There is no default value. If not defined, a n ew GUID is generated. ProjectGUID attribute. There is no default value. If not defined, a n ew GUID is generated.
MSVS_SCC_AUX_PATH MSVS_SCC_AUX_PATH
The path name placed in a generated Microsoft Visual Studio project f ile as the value of the The path name placed in a generated Microsoft Visual Studio project f ile as the value of the
SccAuxPath attribute if the MSVS_SCC_PROVIDER construction variable i s also set. There is no default SccAuxPath attribute if the MSVS_SCC_PROVIDER construction variable i s also set. There is no default
value. value.
skipping to change at line 10269 skipping to change at line 10274
Originally: Steven Knight <knight@baldmt.com> and Anthony Roach <aroach@e lectriceyeball.com> Since 2010: Originally: Steven Knight <knight@baldmt.com> and Anthony Roach <aroach@e lectriceyeball.com> Since 2010:
The SCons Development Team <scons-dev@scons.org> The SCons Development Team <scons-dev@scons.org>
AUTHORS AUTHORS
Steven Knight Steven Knight
Author. Author.
Steven Knight and the SCons Development Team Steven Knight and the SCons Development Team
COPYRIGHT COPYRIGHT
Copyright © 2004 - 2018 The SCons Foundation Copyright © 2004 - 2019 The SCons Foundation
SCons 3.0.4 version 3.0.4 <pubdate>2004 - 2018</pubdate> SCONS(1) SCons 3.0.5 version 3.0.5 <pubdate>2004 - 2019</pubdate> SCONS(1)
 End of changes. 18 change blocks. 
40 lines changed or deleted 49 lines changed or added

Home  |  About  |  Features  |  All  |  Newest  |  Dox  |  Diffs  |  RSS Feeds  |  Screenshots  |  Comments  |  Imprint  |  Privacy  |  HTTP(S)