From 697e33ed224b539a42ff68121f7497f5bbf941b2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Frings-F=C3=BCrst?= Date: Sun, 14 Jul 2019 08:35:24 +0200 Subject: New upstream version 3.0.5 --- doc/generated/builders.gen | 615 ++++++++++++++++++++++++--------------------- 1 file changed, 335 insertions(+), 280 deletions(-) (limited to 'doc/generated/builders.gen') diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index d851c93..dc05443 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -572,75 +572,77 @@ env.Jar(target = 'bar.jar', env.Java() - -Builds one or more Java class files. -The sources may be any combination of explicit -.java files, -or directory trees which will be scanned -for .java files. - - - -SCons will parse each source .java file -to find the classes -(including inner classes) -defined within that file, -and from that figure out the -target .class files that will be created. -The class files will be placed underneath -the specified target directory. - - - -SCons will also search each Java file -for the Java package name, -which it assumes can be found on a line -beginning with the string -package -in the first column; -the resulting .class files -will be placed in a directory reflecting -the specified package name. -For example, -the file -Foo.java -defining a single public -Foo -class and -containing a package name of -sub.dir -will generate a corresponding -sub/dir/Foo.class -class file. - - - -Examples: - - - -env.Java(target = 'classes', source = 'src') -env.Java(target = 'classes', source = ['src1', 'src2']) -env.Java(target = 'classes', source = ['File1.java', 'File2.java']) - - - -Java source files can use the native encoding for the underlying OS. -Since SCons compiles in simple ASCII mode by default, -the compiler will generate warnings about unmappable characters, -which may lead to errors as the file is processed further. -In this case, the user must specify the LANG -environment variable to tell the compiler what encoding is used. -For portibility, it's best if the encoding is hard-coded -so that the compile will work if it is done on a system -with a different encoding. - - - -env = Environment() -env['ENV']['LANG'] = 'en_GB.UTF-8' - - + + Builds one or more Java class files. + The sources may be any combination of explicit + .java + files, + or directory trees which will be scanned + for .java files. + + + + SCons will parse each source .java file + to find the classes + (including inner classes) + defined within that file, + and from that figure out the + target .class files that will be created. + The class files will be placed underneath + the specified target directory. + + + + SCons will also search each Java file + for the Java package name, + which it assumes can be found on a line + beginning with the string + package + in the first column; + the resulting .class files + will be placed in a directory reflecting + the specified package name. + For example, + the file + Foo.java + defining a single public + Foo + class and + containing a package name of + sub.dir + will generate a corresponding + sub/dir/Foo.class + class file. + + + + Examples: + + + + env.Java(target = 'classes', source = 'src') + env.Java(target = 'classes', source = ['src1', 'src2']) + env.Java(target = 'classes', source = ['File1.java', 'File2.java']) + + + + Java source files can use the native encoding for the underlying OS. + Since SCons compiles in simple ASCII mode by default, + the compiler will generate warnings about unmappable characters, + which may lead to errors as the file is processed further. + In this case, the user must specify the + LANG + environment variable to tell the compiler what encoding is used. + For portibility, it's best if the encoding is hard-coded + so that the compile will work if it is done on a system + with a different encoding. + + + + env = Environment() + env['ENV']['LANG'] = 'en_GB.UTF-8' + + @@ -836,148 +838,192 @@ 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. - - - - - 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: - + + + 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'] barmisc = ['bar_readme.txt'] -dll = env.SharedLibrary(target = 'bar.dll', - source = barsrcs) +dll = env.SharedLibrary(target='bar.dll', + source=barsrcs) buildtarget = [s for s in dll if str(s).endswith('dll')] -env.MSVSProject(target = 'Bar' + env['MSVSPROJECTSUFFIX'], - srcs = barsrcs, - incs = barincs, - localincs = barlocalincs, - resources = barresources, - misc = barmisc, - buildtarget = buildtarget, - 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 +env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], + srcs=barsrcs, + incs=barincs, + localincs=barlocalincs, + resources=barresources, + misc=barmisc, + buildtarget=buildtarget, + variant='Release') + + + 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 + + + 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') @@ -986,7 +1032,7 @@ 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") @@ -1021,10 +1067,10 @@ V9DebugSettings = { } # -# 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 +# 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 = { @@ -1056,7 +1102,7 @@ V10DebugSettings = { } # -# 3. Select the dictionary you want depending on the version of visual Studio +# 3. Select the dictionary you want depending on the version of visual Studio # Files you want to generate. # if not env.GetOption('userfile'): @@ -1065,7 +1111,7 @@ elif env.get('MSVC_VERSION', None) == '9.0': dbgSettings = V9DebugSettings elif env.get('MSVC_VERSION', None) == '11.0': dbgSettings = V10DebugSettings -else: +else: dbgSettings = None # @@ -1077,20 +1123,21 @@ 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, {})) - +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, {})) + + @@ -1099,54 +1146,60 @@ 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') + + @@ -1206,13 +1259,15 @@ the following packagers available: * msi - Microsoft Installer - * rpm - Redhat Package Manger + * rpm - RPM Package Manger * ipkg - Itsy Package Management System - * tarbz2 - compressed tar - * targz - compressed tar + * tarbz2 - bzip2 compressed tar + * targz - gzip compressed tar + * tarxz - xz compressed tar * zip - zip file - * src_tarbz2 - compressed tar source - * src_targz - compressed tar source + * src_tarbz2 - bzip2 compressed tar source + * src_targz - gzip compressed tar source + * src_tarxz - xz compressed tar source * src_zip - zip file source @@ -2322,7 +2377,7 @@ and the result replaces the key. -env = Environment(tools = ['default', 'textfile']) +env = Environment(tools=['default']) env['prefix'] = '/usr/bin' script_dict = {'@prefix@': '/bin', '@exec_prefix@': '$prefix'} @@ -2349,7 +2404,7 @@ env.Substfile('bar.in', SUBST_DICT = good_bar) # the SUBST_DICT may be in common (and not an override) substutions = {} -subst = Environment(tools = ['textfile'], SUBST_DICT = substitutions) +subst = Environment(tools=['textfile'], SUBST_DICT=substitutions) substitutions['@foo@'] = 'foo' subst['SUBST_DICT']['@bar@'] = 'bar' subst.Substfile('pgm1.c', [Value('#include "@foo@.h"'), -- cgit v1.2.3 From efdf3fdbcd2f7654cb8d1209a8b040914437bacd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Frings-F=C3=BCrst?= Date: Tue, 23 Jul 2019 16:54:06 +0200 Subject: New upstream version 3.1.0 --- doc/generated/builders.gen | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) (limited to 'doc/generated/builders.gen') diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index dc05443..7c62558 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -849,14 +849,16 @@ Compile files for languages defined in LINGUAS file 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. + file. For Visual Studio 7, 8, and 9, it will + generate a .vcproj file. For Visual + Studio 10 and later, it will generate a + .vcxproj 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 + Visual Studio 7 and later. 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 @@ -928,6 +930,36 @@ Compile files for languages defined in LINGUAS file + + cppdefines + + + Preprocessor definitions for the different variants. + The number of cppdefines 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. If you don't give this parameter, SCons + will use the invoking environment's + CPPDEFINES entry for all variants. + + + + + cpppaths + + + Compiler include paths for the different variants. + The number of cpppaths 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. If you don't give this parameter, SCons + will use the invoking environment's + CPPPATH entry for all variants. + + + buildtarget -- cgit v1.2.3