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/variables.gen | 803 ++++++++++++++++++++++++++------------------ 1 file changed, 478 insertions(+), 325 deletions(-) (limited to 'doc/generated/variables.gen') 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 -- cgit v1.2.3