From f7e5d2b46b03cc4bc09c38f7e0873378bb9c3b78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Frings-F=C3=BCrst?= Date: Sun, 21 Jun 2015 07:55:15 +0200 Subject: Imported Upstream version 2.3.5 --- doc/generated/builders.gen | 528 +++++++++------- doc/generated/examples/troubleshoot_Dump_2.xml | 4 +- doc/generated/functions.gen | 15 +- doc/generated/tools.gen | 27 +- doc/generated/tools.mod | 6 +- doc/generated/variables.gen | 803 +++++++++++++++---------- doc/generated/variables.mod | 36 +- 7 files changed, 851 insertions(+), 568 deletions(-) (limited to 'doc/generated') diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 3d534b0..02dc04b 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -486,6 +486,14 @@ and source arguments list different numbers of files or directories. + + +env.InstallAs(target = '/usr/local/bin/foo', + source = 'foo_debug') +env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], + source = ['libFOO.a', 'libBAR.a']) + + @@ -500,14 +508,17 @@ arguments list different numbers of files or directories. Installs a versioned shared library. The $SHLIBVERSION construction variable should be defined in the environment to confirm the version number in the library name. +If $SHLIBVERSION is not defined a warning will be issued +and the name of the library will be parsed to derive the version. The symlinks appropriate to the architecture will be generated. -env.InstallAs(target = '/usr/local/bin/foo', - source = 'foo_debug') -env.InstallAs(target = ['../lib/libfoo.a', '../lib/libbar.a'], - source = ['libFOO.a', 'libBAR.a']) +env.InstallVersionedLib(target = '/usr/local/bin/foo', + source = 'libxyz.1.5.2.so') +env.InstallVersionedLib(target = '/usr/local/bin/foo', + source = 'libxyz.1.5.2.so', + SHLIBVERSION='1.5.2') @@ -832,161 +843,105 @@ Compile files for languages defined in LINGUAS file env.MSVSProject() - - -Builds a Microsoft Visual Studio project file, -and by default builds a solution file as well. - - - -This builds a Visual Studio project file, based on the version of -Visual Studio that is configured (either the latest installed version, -or the version specified by -$MSVS_VERSION -in the Environment constructor). -For Visual Studio 6, it will generate a -.dsp -file. -For Visual Studio 7 (.NET) and later versions, it will generate a -.vcproj -file. - - - -By default, -this also generates a solution file -for the specified project, -a -.dsw -file for Visual Studio 6 -or a -.sln -file for Visual Studio 7 (.NET). -This behavior may be disabled by specifying -auto_build_solution=0 -when you call -MSVSProject, -in which case you presumably want to -build the solution file(s) -by calling the -MSVSSolution -Builder (see below). - - - -The MSVSProject builder -takes several lists of filenames -to be placed into the project file. -These are currently limited to -srcs, -incs, -localincs, -resources, -and -misc. -These are pretty self-explanatory, but it should be noted that these -lists are added to the $SOURCES construction variable as strings, -NOT as SCons File Nodes. This is because they represent file -names to be added to the project file, not the source files used to -build the project file. - - - -The above filename lists are all optional, -although at least one must be specified -for the resulting project file to be non-empty. - - - -In addition to the above lists of values, -the following values may be specified: - - - -target: -The name of the target -.dsp -or -.vcproj -file. -The correct -suffix for the version of Visual Studio must be used, -but the -$MSVSPROJECTSUFFIX -construction variable -will be defined to the correct value (see example below). - - - -variant: -The name of this particular variant. -For Visual Studio 7 projects, -this can also be a list of variant names. -These are typically things like "Debug" or "Release", but really -can be anything you want. -For Visual Studio 7 projects, -they may also specify a target platform -separated from the variant name by a -| -(vertical pipe) -character: -Debug|Xbox. -The default target platform is Win32. -Multiple calls to -MSVSProject -with different variants are allowed; -all variants will be added to the project file with their appropriate -build targets and sources. - - - -buildtarget: -An optional string, node, or list of strings or nodes -(one per build variant), to tell the Visual Studio debugger -what output target to use in what build variant. -The number of -buildtarget -entries must match the number of -variant -entries. - - - -runfile: -The name of the file that Visual Studio 7 and later -will run and debug. -This appears as the value of the -Output -field in the resutling Visual Studio project file. -If this is not specified, -the default is the same as the specified -buildtarget -value. - - - -Note that because SCons always executes its build commands -from the directory in which the SConstruct file is located, -if you generate a project file in a different directory -than the SConstruct directory, -users will not be able to double-click -on the file name in compilation error messages -displayed in the Visual Studio console output window. -This can be remedied by adding the -Visual C/C++ -/FC -compiler option to the $CCFLAGS variable -so that the compiler will print -the full path name of any -files that cause compilation errors. - - - -Example usage: - - - -barsrcs = ['bar.cpp'], + Builds a Microsoft Visual Studio project +file, and by default builds a solution file as well. This +builds a Visual Studio project file, based on the version of Visual Studio +that is configured (either the latest installed version, or the version +specified by $MSVS_VERSION in the Environment constructor). For +Visual Studio 6, it will generate a .dsp file. For Visual +Studio 7 (.NET) and later versions, it will generate a +.vcproj file. By default, this also +generates a solution file for the specified project, a +.dsw file for Visual Studio 6 or a +.sln file for Visual Studio 7 (.NET). This behavior may +be disabled by specifying auto_build_solution=0 when you +call MSVSProject, in which case you presumably want to build the solution +file(s) by calling the MSVSSolution Builder (see below). +The MSVSProject builder takes several lists of filenames to be placed into +the project file. These are currently limited to srcs, +incs, localincs, +resources, and misc. These are pretty +self-explanatory, but it should be noted that these lists are added to the +$SOURCES construction variable as strings, NOT as SCons File Nodes. +This is because they represent file names to be added to the project file, not +the source files used to build the project file. The above +filename lists are all optional, although at least one must be specified for +the resulting project file to be non-empty. In addition to the +above lists of values, the following values may be specified: + + + target + + + The name of the target .dsp or + .vcproj file. The correct suffix for the version + of Visual Studio must be used, but the $MSVSPROJECTSUFFIX + construction variable will be defined to the correct value (see + example below). + + + + + variant + + + The name of this particular variant. For Visual Studio 7 + projects, this can also be a list of variant names. These are + typically things like "Debug" or "Release", but really can be anything + you want. For Visual Studio 7 projects, they may also specify a target + platform separated from the variant name by a | + (vertical pipe) character: Debug|Xbox. The default + target platform is Win32. Multiple calls to MSVSProject with + different variants are allowed; all variants will be added to the + project file with their appropriate build targets and + sources. + + + + + cmdargs + + + Additional command line arguments for the different + variants. The number of cmdargs entries must match + the number of variant entries, or be empty (not + specified). If you give only one, it will automatically be propagated + to all variants. + + + + + buildtarget + + + An optional string, node, or list of strings or nodes (one + per build variant), to tell the Visual Studio debugger what output + target to use in what build variant. The number of + buildtarget entries must match the number of + variant entries. + + + + + runfile + + + The name of the file that Visual Studio 7 and later will + run and debug. This appears as the value of the + Output field in the resulting Visual Studio project + file. If this is not specified, the default is the same as the + specified buildtarget value. + + + Note that because SCons always executes its build +commands from the directory in which the SConstruct file is located, if you +generate a project file in a different directory than the SConstruct +directory, users will not be able to double-click on the file name in +compilation error messages displayed in the Visual Studio console output +window. This can be remedied by adding the Visual C/C++ /FC +compiler option to the $CCFLAGS variable so that the compiler will +print the full path name of any files that cause compilation errors. + Example usage: barsrcs = ['bar.cpp'], barincs = ['bar.h'], barlocalincs = ['StdAfx.h'] barresources = ['bar.rc','resource.h'] @@ -1004,7 +959,143 @@ env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], buildtarget = dll, variant = 'Release') - +Starting with version 2.4 of +SCons it's also possible to specify the optional argument +DebugSettings, which creates files for debugging under +Visual Studio: + + DebugSettings + + + A dictionary of debug settings that get written to the + .vcproj.user or the + .vcxproj.user file, depending on the version + installed. As it is done for cmdargs (see above), you can specify a + DebugSettings dictionary per variant. If you + give only one, it will be propagated to all variants. + + + 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 the environment with the +right parameters for your MSVS version. If the dictionary is empty, or does +not contain any good value, no file will be generated.Following +is a more contrived example, involving the setup of a project for variants and +DebugSettings:# Assuming you store your defaults in a file +vars = Variables('variables.py') +msvcver = vars.args.get('vc', '9') + +# Check command args to force one Microsoft Visual Studio version +if msvcver == '9' or msvcver == '11': + env = Environment(MSVC_VERSION=msvcver+'.0', MSVC_BATCH=False) +else: + env = Environment() + +AddOption('--userfile', action='store_true', dest='userfile', default=False, + help="Create Visual Studio Project user file") + +# +# 1. Configure your Debug Setting dictionary with options you want in the list +# of allowed options, for instance if you want to create a user file to launch +# a specific application for testing your dll with Microsoft Visual Studio 2008 (v9): +# +V9DebugSettings = { + 'Command':'c:\\myapp\\using\\thisdll.exe', + 'WorkingDirectory': 'c:\\myapp\\using\\', + 'CommandArguments': '-p password', +# 'Attach':'false', +# 'DebuggerType':'3', +# 'Remote':'1', +# 'RemoteMachine': None, +# 'RemoteCommand': None, +# 'HttpUrl': None, +# 'PDBPath': None, +# 'SQLDebugging': None, +# 'Environment': '', +# 'EnvironmentMerge':'true', +# 'DebuggerFlavor': None, +# 'MPIRunCommand': None, +# 'MPIRunArguments': None, +# 'MPIRunWorkingDirectory': None, +# 'ApplicationCommand': None, +# 'ApplicationArguments': None, +# 'ShimCommand': None, +# 'MPIAcceptMode': None, +# 'MPIAcceptFilter': None, +} + +# +# 2. Because there are a lot of different options depending on the Microsoft +# Visual Studio version, if you use more than one version you have to +# define a dictionary per version, for instance if you want to create a user +# file to launch a specific application for testing your dll with Microsoft +# Visual Studio 2012 (v11): +# +V10DebugSettings = { + 'LocalDebuggerCommand': 'c:\\myapp\\using\\thisdll.exe', + 'LocalDebuggerWorkingDirectory': 'c:\\myapp\\using\\', + 'LocalDebuggerCommandArguments': '-p password', +# 'LocalDebuggerEnvironment': None, +# 'DebuggerFlavor': 'WindowsLocalDebugger', +# 'LocalDebuggerAttach': None, +# 'LocalDebuggerDebuggerType': None, +# 'LocalDebuggerMergeEnvironment': None, +# 'LocalDebuggerSQLDebugging': None, +# 'RemoteDebuggerCommand': None, +# 'RemoteDebuggerCommandArguments': None, +# 'RemoteDebuggerWorkingDirectory': None, +# 'RemoteDebuggerServerName': None, +# 'RemoteDebuggerConnection': None, +# 'RemoteDebuggerDebuggerType': None, +# 'RemoteDebuggerAttach': None, +# 'RemoteDebuggerSQLDebugging': None, +# 'DeploymentDirectory': None, +# 'AdditionalFiles': None, +# 'RemoteDebuggerDeployDebugCppRuntime': None, +# 'WebBrowserDebuggerHttpUrl': None, +# 'WebBrowserDebuggerDebuggerType': None, +# 'WebServiceDebuggerHttpUrl': None, +# 'WebServiceDebuggerDebuggerType': None, +# 'WebServiceDebuggerSQLDebugging': None, +} + +# +# 3. Select the dictionary you want depending on the version of visual Studio +# Files you want to generate. +# +if not env.GetOption('userfile'): + dbgSettings = None +elif env.get('MSVC_VERSION', None) == '9.0': + dbgSettings = V9DebugSettings +elif env.get('MSVC_VERSION', None) == '11.0': + dbgSettings = V10DebugSettings +else: + dbgSettings = None + +# +# 4. Add the dictionary to the DebugSettings keyword. +# +barsrcs = ['bar.cpp', 'dllmain.cpp', 'stdafx.cpp'] +barincs = ['targetver.h'] +barlocalincs = ['StdAfx.h'] +barresources = ['bar.rc','resource.h'] +barmisc = ['ReadMe.txt'] + +dll = env.SharedLibrary(target = 'bar.dll', + source = barsrcs) + +env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], + srcs = barsrcs, + incs = barincs, + localincs = barlocalincs, + resources = barresources, + misc = barmisc, + buildtarget = [dll[0]] * 2, + variant = ('Debug|Win32', 'Release|Win32'), + cmdargs = 'vc=%s' % msvcver, + DebugSettings = (dbgSettings, {})) + @@ -1013,70 +1104,54 @@ env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], env.MSVSSolution() - - -Builds a Microsoft Visual Studio solution file. - - - -This builds a Visual Studio solution file, -based on the version of Visual Studio that is configured -(either the latest installed version, -or the version specified by -$MSVS_VERSION -in the construction environment). -For Visual Studio 6, it will generate a -.dsw -file. -For Visual Studio 7 (.NET), it will -generate a -.sln -file. - - - -The following values must be specified: - - - -target: -The name of the target .dsw or .sln file. The correct -suffix for the version of Visual Studio must be used, but the value -$MSVSSOLUTIONSUFFIX -will be defined to the correct value (see example below). - - - -variant: -The name of this particular variant, or a list of variant -names (the latter is only supported for MSVS 7 solutions). These are -typically things like "Debug" or "Release", but really can be anything -you want. For MSVS 7 they may also specify target platform, like this -"Debug|Xbox". Default platform is Win32. - - - -projects: -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 file names are NOT added to the $SOURCES -environment variable in form of files, but rather as strings. This -is because they represent file names to be added to the solution file, -not the source files used to build the solution file. - - - -Example Usage: - - - -env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], - projects = ['bar' + env['MSVSPROJECTSUFFIX']], - variant = 'Release') - - + Builds a Microsoft Visual Studio solution +file. This builds a Visual Studio solution file, based on the +version of Visual Studio that is configured (either the latest installed +version, or the version specified by $MSVS_VERSION in the +construction environment). For Visual Studio 6, it will generate a +.dsw file. For Visual Studio 7 (.NET), it will generate a +.sln file. The following values must be +specified: + + target + + + The name of the target .dsw or .sln file. The correct + suffix for the version of Visual Studio must be used, but the value + $MSVSSOLUTIONSUFFIX will be defined to the correct value (see + example below). + + + + + variant + + + The name of this particular variant, or a list of variant + names (the latter is only supported for MSVS 7 solutions). These are + typically things like "Debug" or "Release", but really can be anything + you want. For MSVS 7 they may also specify target platform, like this + "Debug|Xbox". Default platform is Win32. + + + + + projects + + + 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 file names are NOT added to the + $SOURCES environment variable in form of files, but rather as strings. + This is because they represent file names to be added to the solution + file, not the source files used to build the solution + file. + + + Example Usage: +env.MSVSSolution(target = 'Bar' + env['MSVSSOLUTIONSUFFIX'], projects = ['bar' ++ env['MSVSPROJECTSUFFIX']], variant = 'Release') + @@ -1925,6 +2000,11 @@ and Y are numbers, and Z is a number but can also contain letters to designate alpha, beta, or release candidate patch levels. + +env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'], SHLIBVERSION='1.5.2') + + + This builder may create multiple links to the library. On a POSIX system, for the shared library libbar.so.2.3.1, the links created would be diff --git a/doc/generated/examples/troubleshoot_Dump_2.xml b/doc/generated/examples/troubleshoot_Dump_2.xml index 17c9de5..d6fa404 100644 --- a/doc/generated/examples/troubleshoot_Dump_2.xml +++ b/doc/generated/examples/troubleshoot_Dump_2.xml @@ -34,7 +34,7 @@ scons: Reading SConscript files ... '.SPP', '.sx'], 'CXX': '$CC', - 'CXXCOM': '${TEMPFILE("$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS $CCFLAGS $_CCCOMCOM")}', + 'CXXCOM': '${TEMPFILE("$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS $CCFLAGS $_CCCOMCOM","$CXXCOMSTR")}', 'CXXFILESUFFIX': '.cc', 'CXXFLAGS': ['$(', '/TP', '$)'], 'DSUFFIXES': ['.d'], @@ -77,7 +77,7 @@ scons: Reading SConscript files ... 'SHCCFLAGS': ['$CCFLAGS'], 'SHCFLAGS': ['$CFLAGS'], 'SHCXX': '$CXX', - 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM")}', + 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM","$SHCXXCOMSTR")}', 'SHCXXFLAGS': ['$CXXFLAGS'], 'SHELL': None, 'SHLIBPREFIX': '', diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index 62a9ab3..3ad36e5 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -2426,10 +2426,10 @@ option. - Glob(pattern, [ondisk, source, strings]) + Glob(pattern, [ondisk, source, strings, exclude]) - env.Glob(pattern, [ondisk, source, strings]) + env.Glob(pattern, [ondisk, source, strings, exclude]) @@ -2542,6 +2542,16 @@ not the original directory.) + +The +exclude +argument may be set to a pattern or a list of patterns +(following the same Unix shell semantics) +which must be filtered out of returned elements. +Elements matching a least one pattern of +this list will be excluded. + + Examples: @@ -2549,6 +2559,7 @@ Examples: Program('foo', Glob('*.c')) Zip('/tmp/everything', Glob('.??*') + Glob('*')) +sources = Glob('*.cpp', exclude=['os_*_specific_*.cpp']) + Glob('os_%s_specific_*.cpp'%currentOS) diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index 539c5e6..db89475 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -306,6 +306,14 @@ Sets construction variables for the dvips utility. Set construction variables for generic POSIX Fortran 03 compilers. Sets: &cv-link-F03;, &cv-link-F03COM;, &cv-link-F03FLAGS;, &cv-link-F03PPCOM;, &cv-link-SHF03;, &cv-link-SHF03COM;, &cv-link-SHF03FLAGS;, &cv-link-SHF03PPCOM;, &cv-link-_F03INCFLAGS;.Uses: &cv-link-F03COMSTR;, &cv-link-F03PPCOMSTR;, &cv-link-SHF03COMSTR;, &cv-link-SHF03PPCOMSTR;. + + + f08 + + +Set construction variables for generic POSIX Fortran 08 compilers. + +Sets: &cv-link-F08;, &cv-link-F08COM;, &cv-link-F08FLAGS;, &cv-link-F08PPCOM;, &cv-link-SHF08;, &cv-link-SHF08COM;, &cv-link-SHF08FLAGS;, &cv-link-SHF08PPCOM;, &cv-link-_F08INCFLAGS;.Uses: &cv-link-F08COMSTR;, &cv-link-F08PPCOMSTR;, &cv-link-SHF08COMSTR;, &cv-link-SHF08PPCOMSTR;. f77 @@ -736,11 +744,8 @@ Sets construction variables for the Microsoft Visual C/C++ compiler. msvs - - -Sets construction variables for Microsoft Visual Studio. - -Sets: &cv-link-MSVSBUILDCOM;, &cv-link-MSVSCLEANCOM;, &cv-link-MSVSENCODING;, &cv-link-MSVSPROJECTCOM;, &cv-link-MSVSREBUILDCOM;, &cv-link-MSVSSCONS;, &cv-link-MSVSSCONSCOM;, &cv-link-MSVSSCONSCRIPT;, &cv-link-MSVSSCONSFLAGS;, &cv-link-MSVSSOLUTIONCOM;. + +Sets construction variables for Microsoft Visual Studio. Sets: &cv-link-MSVSBUILDCOM;, &cv-link-MSVSCLEANCOM;, &cv-link-MSVSENCODING;, &cv-link-MSVSPROJECTCOM;, &cv-link-MSVSREBUILDCOM;, &cv-link-MSVSSCONS;, &cv-link-MSVSSCONSCOM;, &cv-link-MSVSSCONSCRIPT;, &cv-link-MSVSSCONSFLAGS;, &cv-link-MSVSSOLUTIONCOM;. mwcc @@ -767,19 +772,19 @@ Sets construction variables for the Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;. - - Packaging + + packaging -Sets construction variables for the Package Builder. +A framework for building binary and source packages. - - packaging + + Packaging -A framework for building binary and source packages. +Sets construction variables for the Package Builder. diff --git a/doc/generated/tools.mod b/doc/generated/tools.mod index 13072bf..5a5795a 100644 --- a/doc/generated/tools.mod +++ b/doc/generated/tools.mod @@ -29,6 +29,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. dvipdf"> dvips"> f03"> +f08"> f77"> f90"> f95"> @@ -76,8 +77,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. mwcc"> mwld"> nasm"> -Packaging"> packaging"> +Packaging"> pdf"> pdflatex"> pdftex"> @@ -138,6 +139,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. dvipdf"> dvips"> f03"> +f08"> f77"> f90"> f95"> @@ -185,8 +187,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. mwcc"> mwld"> nasm"> -Packaging"> packaging"> +Packaging"> pdf"> pdflatex"> pdftex"> diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 34b9017..120b4a3 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -950,19 +950,19 @@ DFLAGPREFIX. - - _DFLAGS + + DFLAGS -_DFLAGS. +DFLAGS. - - DFLAGS + + _DFLAGS -DFLAGS. +_DFLAGS. @@ -1684,6 +1684,184 @@ If this is not set, then + F08 + + +The Fortran 08 compiler. +You should normally set the $FORTRAN variable, +which specifies the default Fortran compiler +for all Fortran versions. +You only need to set $F08 if you need to use a specific compiler +or compiler version for Fortran 08 files. + + + + + F08COM + + +The command line used to compile a Fortran 08 source file to an object file. +You only need to set $F08COM if you need to use a specific +command line for Fortran 08 files. +You should normally set the $FORTRANCOM variable, +which specifies the default command line +for all Fortran versions. + + + + + F08COMSTR + + +The string displayed when a Fortran 08 source file +is compiled to an object file. +If this is not set, then $F08COM or $FORTRANCOM +(the command line) is displayed. + + + + + F08FILESUFFIXES + + +The list of file extensions for which the F08 dialect will be used. By +default, this is ['.f08'] + + + + + F08FLAGS + + +General user-specified options that are passed to the Fortran 08 compiler. +Note that this variable does +not +contain + +(or similar) include search path options +that scons generates automatically from $F08PATH. +See +$_F08INCFLAGS +below, +for the variable that expands to those options. +You only need to set $F08FLAGS if you need to define specific +user options for Fortran 08 files. +You should normally set the $FORTRANFLAGS variable, +which specifies the user-specified options +passed to the default Fortran compiler +for all Fortran versions. + + + + + _F08INCFLAGS + + +An automatically-generated construction variable +containing the Fortran 08 compiler command-line options +for specifying directories to be searched for include files. +The value of $_F08INCFLAGS is created +by appending $INCPREFIX and $INCSUFFIX +to the beginning and end +of each directory in $F08PATH. + + + + + F08PATH + + +The list of directories that the Fortran 08 compiler will search for include +directories. The implicit dependency scanner will search these +directories for include files. Don't explicitly put include directory +arguments in $F08FLAGS because the result will be non-portable +and the directories will not be searched by the dependency scanner. Note: +directory names in $F08PATH will be looked-up relative to the SConscript +directory when they are used in a command. To force +scons +to look-up a directory relative to the root of the source tree use #: +You only need to set $F08PATH if you need to define a specific +include path for Fortran 08 files. +You should normally set the $FORTRANPATH variable, +which specifies the include path +for the default Fortran compiler +for all Fortran versions. + + + +env = Environment(F08PATH='#/include') + + + +The directory look-up can also be forced using the +Dir() +function: + + + +include = Dir('include') +env = Environment(F08PATH=include) + + + +The directory list will be added to command lines +through the automatically-generated +$_F08INCFLAGS +construction variable, +which is constructed by +appending the values of the +$INCPREFIX and $INCSUFFIX +construction variables +to the beginning and end +of each directory in $F08PATH. +Any command lines you define that need +the F08PATH directory list should +include $_F08INCFLAGS: + + + +env = Environment(F08COM="my_compiler $_F08INCFLAGS -c -o $TARGET $SOURCE") + + + + + F08PPCOM + + +The command line used to compile a Fortran 08 source file to an object file +after first running the file through the C preprocessor. +Any options specified in the $F08FLAGS and $CPPFLAGS construction variables +are included on this command line. +You only need to set $F08PPCOM if you need to use a specific +C-preprocessor command line for Fortran 08 files. +You should normally set the $FORTRANPPCOM variable, +which specifies the default C-preprocessor command line +for all Fortran versions. + + + + + F08PPCOMSTR + + +The string displayed when a Fortran 08 source file +is compiled to an object file +after first running the file through the C preprocessor. +If this is not set, then $F08PPCOM or $FORTRANPPCOM +(the command line) is displayed. + + + + + F08PPFILESUFFIXES + + +The list of file extensions for which the compilation + preprocessor pass for +F08 dialect will be used. By default, this is empty + @@ -2641,15 +2819,6 @@ is -dNOPAUSE -dBATCH -sDEVICE=pdfwrite HOST_ARCH - - The name of the host hardware architecture used to create the Environment. - If a platform is specified when creating the Environment, then - that Platform's logic will handle setting this value. - This value is immutable, and should not be changed by the user after - the Environment is initialized. - Currently only set for Win32. - - Sets the host architecture for Visual Studio compiler. If not set, default to the detected host architecture: note that this may depend @@ -2666,7 +2835,16 @@ Valid values are the same as for This is currently only used on Windows, but in the future it will be used on other OSes as well. - + + + The name of the host hardware architecture used to create the Environment. + If a platform is specified when creating the Environment, then + that Platform's logic will handle setting this value. + This value is immutable, and should not be changed by the user after + the Environment is initialized. + Currently only set for Win32. + + HOST_OS @@ -2862,7 +3040,7 @@ The command line used to call the Java archive tool. The string displayed when the Java archive tool is called -If this is not set, then $JARCOM (the command line) is displayed. +If this is not set, then $JARCOM (the command line) is displayed. @@ -2872,7 +3050,7 @@ env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") The string displayed when the Java archive tool is called -If this is not set, then $JARCOM (the command line) is displayed. +If this is not set, then $JARCOM (the command line) is displayed. @@ -3978,355 +4156,254 @@ Versions ending in Exp refer to "Express" or MSVS - - -When the Microsoft Visual Studio tools are initialized, they set up -this dictionary with the following keys: - - - -VERSION: -the version of MSVS being used (can be set via -$MSVS_VERSION) - - - -VERSIONS: -the available versions of MSVS installed - - - -VCINSTALLDIR: -installed directory of Visual C++ - - - -VSINSTALLDIR: -installed directory of Visual Studio - - - -FRAMEWORKDIR: -installed directory of the .NET framework - - - -FRAMEWORKVERSIONS: -list of installed versions of the .NET framework, sorted latest to oldest. - - - -FRAMEWORKVERSION: -latest installed version of the .NET framework - - - -FRAMEWORKSDKDIR: -installed location of the .NET SDK. - - - -PLATFORMSDKDIR: -installed location of the Platform SDK. - - - -PLATFORMSDK_MODULES: -dictionary of installed Platform SDK modules, -where the dictionary keys are keywords for the various modules, and -the values are 2-tuples where the first is the release date, and the -second is the version number. - - - -If a value isn't set, it wasn't available in the registry. - - + +When the Microsoft Visual Studio tools are initialized, they set up this +dictionary with the following keys: + + VERSION + + + the version of MSVS being used (can be set via + $MSVS_VERSION) + + + + + VERSIONS + + + the available versions of MSVS installed + + + + + VCINSTALLDIR + + + installed directory of Visual C++ + + + + + VSINSTALLDIR + + + installed directory of Visual Studio + + + + + FRAMEWORKDIR + + + installed directory of the .NET framework + + + + + FRAMEWORKVERSIONS + + + list of installed versions of the .NET framework, sorted + latest to oldest. + + + + + FRAMEWORKVERSION + + + latest installed version of the .NET + framework + + + + + FRAMEWORKSDKDIR + + + installed location of the .NET SDK. + + + + + PLATFORMSDKDIR + + + installed location of the Platform SDK. + + + + + PLATFORMSDK_MODULES + + + dictionary of installed Platform SDK modules, where the + dictionary keys are keywords for the various modules, and the values + are 2-tuples where the first is the release date, and the second is + the version number. + + + If a value isn't set, it wasn't available in the +registry. MSVS_ARCH - - -Sets the architecture for which the generated project(s) should build. - - - -The default value is x86. -amd64 is also supported -by SCons for some Visual Studio versions. -Trying to set $MSVS_ARCH to an architecture that's not -supported for a given Visual Studio version -will generate an error. - - + Sets +the architecture for which the generated project(s) should build. +The default value is x86. amd64 is +also supported by SCons for some Visual Studio versions. Trying to set +$MSVS_ARCH to an architecture that's not supported for a given Visual +Studio version will generate an error. MSVS_PROJECT_GUID - - -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 new GUID is generated. - - + 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 new GUID is generated. MSVS_SCC_AUX_PATH - - -The path name -placed in a generated Microsoft Visual Studio project file -as the value of the -SccAuxPath -attribute -if the -MSVS_SCC_PROVIDER -construction variable is also set. -There is no default value. - - + The path name placed in a generated +Microsoft Visual Studio project file as the value of the +SccAuxPath attribute if the +MSVS_SCC_PROVIDER construction variable is also set. There is +no default value. MSVS_SCC_CONNECTION_ROOT - - -The root path of projects in your SCC workspace, i.e the path under which -all project and solution files will be generated. It is used as a -reference path from which the relative paths of the generated -Microsoft Visual Studio project and solution files are computed. -The relative project file path is placed as the value of the -SccLocalPath -attribute -of the project file -and as the values of the -SccProjectFilePathRelativizedFromConnection[i] -(where [i] ranges from 0 to the number of projects in the solution) -attributes of the -GlobalSection(SourceCodeControl) -section of the Microsoft Visual Studio solution file. -Similarly the relative solution file path is placed as the values of the -SccLocalPath[i] -(where [i] ranges from 0 to the number of projects in the solution) -attributes of the -GlobalSection(SourceCodeControl) -section of the Microsoft Visual Studio solution file. -This is used only -if the -MSVS_SCC_PROVIDER -construction variable is also set. -The default value is the current working directory. - - + The root path of projects in +your SCC workspace, i.e the path under which all project and solution files +will be generated. It is used as a reference path from which the relative +paths of the generated Microsoft Visual Studio project and solution files are +computed. The relative project file path is placed as the value of the +SccLocalPath attribute of the project file and as the +values of the +SccProjectFilePathRelativizedFromConnection[i] (where [i] +ranges from 0 to the number of projects in the solution) attributes of the +GlobalSection(SourceCodeControl) section of the Microsoft +Visual Studio solution file. Similarly the relative solution file path is +placed as the values of the SccLocalPath[i] (where [i] +ranges from 0 to the number of projects in the solution) attributes of the +GlobalSection(SourceCodeControl) section of the Microsoft +Visual Studio solution file. This is used only if the +MSVS_SCC_PROVIDER construction variable is also set. The +default value is the current working directory. MSVS_SCC_PROJECT_NAME - - -The project name -placed in a generated Microsoft Visual Studio project file -as the value of the -SccProjectName -attribute -if the -MSVS_SCC_PROVIDER -construction variable is also set. -In this case the string is also placed in the -SccProjectName0 -attribute of the -GlobalSection(SourceCodeControl) -section of the Microsoft Visual Studio solution file. -There is no default value. - - + The project name placed in +a generated Microsoft Visual Studio project file as the value of the +SccProjectName attribute if the +MSVS_SCC_PROVIDER construction variable is also set. In this +case the string is also placed in the SccProjectName0 +attribute of the GlobalSection(SourceCodeControl) section +of the Microsoft Visual Studio solution file. There is no default value. + MSVS_SCC_PROVIDER - - -The string -placed in a generated Microsoft Visual Studio project file -as the value of the -SccProvider -attribute. -The string is also placed in the -SccProvider0 -attribute of the -GlobalSection(SourceCodeControl) -section of the Microsoft Visual Studio solution file. -There is no default value. - - + The +string placed in a generated Microsoft Visual Studio project file as the value +of the SccProvider attribute. The string is also placed in +the SccProvider0 attribute of the +GlobalSection(SourceCodeControl) section of the Microsoft +Visual Studio solution file. There is no default value. MSVS_VERSION - - -Sets the preferred version of Microsoft Visual Studio to use. - - - -If $MSVS_VERSION is not set, -SCons will (by default) select the latest version -of Visual Studio installed on your system. -So, if you have version 6 and version 7 (MSVS .NET) installed, -it will prefer version 7. -You can override this by -specifying the -MSVS_VERSION -variable in the Environment initialization, setting it to the -appropriate version ('6.0' or '7.0', for example). -If the specified version isn't installed, -tool initialization will fail. - - - -This is obsolete: use $MSVC_VERSION instead. If $MSVS_VERSION is set and -$MSVC_VERSION is not, $MSVC_VERSION will be set automatically to $MSVS_VERSION. -If both are set to different values, scons will raise an error. - - + Sets the preferred version +of Microsoft Visual Studio to use. If $MSVS_VERSION is not +set, SCons will (by default) select the latest version of Visual Studio +installed on your system. So, if you have version 6 and version 7 (MSVS .NET) +installed, it will prefer version 7. You can override this by specifying the +MSVS_VERSION variable in the Environment initialization, +setting it to the appropriate version ('6.0' or '7.0', for example). If the +specified version isn't installed, tool initialization will fail. +This is obsolete: use $MSVC_VERSION instead. If $MSVS_VERSION is +set and $MSVC_VERSION is not, $MSVC_VERSION will be set automatically +to $MSVS_VERSION. If both are set to different values, scons will raise an +error. MSVSBUILDCOM - -The build command line placed in -a generated Microsoft Visual Studio project file. -The default is to have Visual Studio invoke SCons with any specified -build targets. - - +The build command line placed in a generated Microsoft Visual Studio +project file. The default is to have Visual Studio invoke SCons with any +specified build targets. MSVSCLEANCOM - - -The clean command line placed in -a generated Microsoft Visual Studio project file. -The default is to have Visual Studio invoke SCons with the -c option -to remove any specified targets. - - + The clean command line placed in a generated Microsoft Visual +Studio project file. The default is to have Visual Studio invoke SCons with +the -c option to remove any specified targets. MSVSENCODING - - -The encoding string placed in -a generated Microsoft Visual Studio project file. -The default is encoding -Windows-1252. - - + The encoding string placed in a +generated Microsoft Visual Studio project file. The default is encoding +Windows-1252. MSVSPROJECTCOM - - -The action used to generate Microsoft Visual Studio project files. - - + The action used to generate Microsoft +Visual Studio project files. MSVSPROJECTSUFFIX - - -The suffix used for Microsoft Visual Studio project (DSP) files. -The default value is -.vcproj -when using Visual Studio version 7.x (.NET) -or later version, -and -.dsp -when using earlier versions of Visual Studio. - - + The suffix used for Microsoft Visual +Studio project (DSP) files. The default value is .vcproj +when using Visual Studio version 7.x (.NET) or later version, and +.dsp when using earlier versions of Visual Studio. + MSVSREBUILDCOM - - -The rebuild command line placed in -a generated Microsoft Visual Studio project file. -The default is to have Visual Studio invoke SCons with any specified -rebuild targets. - - + The +rebuild command line placed in a generated Microsoft Visual Studio project +file. The default is to have Visual Studio invoke SCons with any specified +rebuild targets. MSVSSCONS - -The SCons used in generated Microsoft Visual Studio project files. -The default is the version of SCons being -used to generate the project file. - - +The SCons used in generated Microsoft Visual Studio project files. The +default is the version of SCons being used to generate the project file. + MSVSSCONSCOM - - -The default SCons command used in generated Microsoft Visual Studio -project files. - + The default +SCons command used in generated Microsoft Visual Studio project files. MSVSSCONSCRIPT - - -The sconscript file -(that is, -SConstruct -or -SConscript -file) -that will be invoked by Visual Studio -project files -(through the -$MSVSSCONSCOM -variable). -The default is the same sconscript file -that contains the call to -MSVSProject -to build the project file. - - + The sconscript +file (that is, SConstruct or SConscript file) that will be invoked by +Visual Studio project files (through the $MSVSSCONSCOM variable). The +default is the same sconscript file that contains the call to MSVSProject +to build the project file. MSVSSCONSFLAGS - - -The SCons flags used in generated Microsoft Visual Studio -project files. - + The +SCons flags used in generated Microsoft Visual Studio project files. MSVSSOLUTIONCOM - - -The action used to generate Microsoft Visual Studio solution files. - - + The action used to generate Microsoft +Visual Studio solution files. MSVSSOLUTIONSUFFIX - - -The suffix used for Microsoft Visual Studio solution (DSW) files. -The default value is -.sln -when using Visual Studio version 7.x (.NET), -and -.dsw -when using earlier versions of Visual Studio. - - + The suffix used for Microsoft +Visual Studio solution (DSW) files. The default value is +.sln when using Visual Studio version 7.x (.NET), and +.dsw when using earlier versions of Visual Studio. + MT @@ -5672,17 +5749,11 @@ to check out editable files from SCCS. SCONS_HOME - - -The (optional) path to the SCons library directory, -initialized from the external environment. -If set, this is used to construct a shorter and more -efficient search path in the -$MSVSSCONS -command line executed -from Microsoft Visual Studio project files. - - + The +(optional) path to the SCons library directory, initialized from the external +environment. If set, this is used to construct a shorter and more efficient +search path in the $MSVSSCONS command line executed from Microsoft +Visual Studio project files. SHCC @@ -5913,6 +5984,88 @@ after first running the file through the C preprocessor. If this is not set, then $SHF03PPCOM or $SHFORTRANPPCOM (the command line) is displayed. + + + + SHF08 + + +The Fortran 08 compiler used for generating shared-library objects. +You should normally set the $SHFORTRAN variable, +which specifies the default Fortran compiler +for all Fortran versions. +You only need to set $SHF08 if you need to use a specific compiler +or compiler version for Fortran 08 files. + + + + + SHF08COM + + +The command line used to compile a Fortran 08 source file +to a shared-library object file. +You only need to set $SHF08COM if you need to use a specific +command line for Fortran 08 files. +You should normally set the $SHFORTRANCOM variable, +which specifies the default command line +for all Fortran versions. + + + + + SHF08COMSTR + + +The string displayed when a Fortran 08 source file +is compiled to a shared-library object file. +If this is not set, then $SHF08COM or $SHFORTRANCOM +(the command line) is displayed. + + + + + SHF08FLAGS + + +Options that are passed to the Fortran 08 compiler +to generated shared-library objects. +You only need to set $SHF08FLAGS if you need to define specific +user options for Fortran 08 files. +You should normally set the $SHFORTRANFLAGS variable, +which specifies the user-specified options +passed to the default Fortran compiler +for all Fortran versions. + + + + + SHF08PPCOM + + +The command line used to compile a Fortran 08 source file to a +shared-library object file +after first running the file through the C preprocessor. +Any options specified in the $SHF08FLAGS and $CPPFLAGS construction variables +are included on this command line. +You only need to set $SHF08PPCOM if you need to use a specific +C-preprocessor command line for Fortran 08 files. +You should normally set the $SHFORTRANPPCOM variable, +which specifies the default C-preprocessor command line +for all Fortran versions. + + + + + SHF08PPCOMSTR + + +The string displayed when a Fortran 08 source file +is compiled to a shared-library object file +after first running the file through the C preprocessor. +If this is not set, then $SHF08PPCOM or $SHFORTRANPPCOM +(the command line) is displayed. + @@ -6712,13 +6865,6 @@ that may not be set or used in a construction environment. TARGET_ARCH - - The name of the target hardware architecture for the compiled objects - created by this Environment. - This defaults to the value of HOST_ARCH, and the user can override it. - Currently only set for Win32. - - Sets the target architecture for Visual Studio compiler (i.e. the arch of the binaries generated by the compiler). If not set, default to @@ -6744,7 +6890,14 @@ and ia64 (Itanium). For example, if you want to compile 64-bit binaries, you would set TARGET_ARCH='x86_64' in your SCons environment. - + + + The name of the target hardware architecture for the compiled objects + created by this Environment. + This defaults to the value of HOST_ARCH, and the user can override it. + Currently only set for Win32. + + TARGET_OS diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index 473c8a2..3f254a5 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -76,8 +76,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $DESCRIPTION_lang"> $DFILESUFFIX"> $DFLAGPREFIX"> -$_DFLAGS"> $DFLAGS"> +$_DFLAGS"> $DFLAGSUFFIX"> $_DINCFLAGS"> $DINCPREFIX"> @@ -144,6 +144,16 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $F03PPCOM"> $F03PPCOMSTR"> $F03PPFILESUFFIXES"> +$F08"> +$F08COM"> +$F08COMSTR"> +$F08FILESUFFIXES"> +$F08FLAGS"> +$_F08INCFLAGS"> +$F08PATH"> +$F08PPCOM"> +$F08PPCOMSTR"> +$F08PPFILESUFFIXES"> $F77"> $F77COM"> $F77COMSTR"> @@ -464,6 +474,12 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $SHF03FLAGS"> $SHF03PPCOM"> $SHF03PPCOMSTR"> +$SHF08"> +$SHF08COM"> +$SHF08COMSTR"> +$SHF08FLAGS"> +$SHF08PPCOM"> +$SHF08PPCOMSTR"> $SHF77"> $SHF77COM"> $SHF77COMSTR"> @@ -698,8 +714,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $DESCRIPTION_lang"> $DFILESUFFIX"> $DFLAGPREFIX"> -$_DFLAGS"> $DFLAGS"> +$_DFLAGS"> $DFLAGSUFFIX"> $_DINCFLAGS"> $DINCPREFIX"> @@ -766,6 +782,16 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $F03PPCOM"> $F03PPCOMSTR"> $F03PPFILESUFFIXES"> +$F08"> +$F08COM"> +$F08COMSTR"> +$F08FILESUFFIXES"> +$F08FLAGS"> +$_F08INCFLAGS"> +$F08PATH"> +$F08PPCOM"> +$F08PPCOMSTR"> +$F08PPFILESUFFIXES"> $F77"> $F77COM"> $F77COMSTR"> @@ -1086,6 +1112,12 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $SHF03FLAGS"> $SHF03PPCOM"> $SHF03PPCOMSTR"> +$SHF08"> +$SHF08COM"> +$SHF08COMSTR"> +$SHF08FLAGS"> +$SHF08PPCOM"> +$SHF08PPCOMSTR"> $SHF77"> $SHF77COM"> $SHF77COMSTR"> -- cgit v1.2.3