From 600e0c897aaed2bf0f9ad6586925434103bfe389 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Fri, 8 May 2020 09:13:06 -0600 Subject: [WIP] adjust docbuild for moved src [ci skip] src/engine/SCons moved to SCons, affects wired in paths in documentation, and doc building scripts Signed-off-by: Mats Wichmann --- SCons/Action.xml | 10 +- SCons/Defaults.xml | 10 +- SCons/Environment.xml | 10 +- SCons/Platform/__init__.xml | 10 +- SCons/Platform/posix.xml | 10 +- SCons/Platform/sunos.xml | 10 +- SCons/Platform/win32.xml | 10 +- SCons/Scanner/__init__.xml | 10 +- SCons/Script/Main.xml | 10 +- SCons/Script/SConscript.xml | 10 +- SCons/Subst.xml | 10 +- SCons/Tool/386asm.xml | 10 +- SCons/Tool/DCommon.xml | 10 +- SCons/Tool/__init__.xml | 10 +- SCons/Tool/aixc++.xml | 10 +- SCons/Tool/aixcc.xml | 10 +- SCons/Tool/aixf77.xml | 10 +- SCons/Tool/aixlink.xml | 10 +- SCons/Tool/applelink.xml | 10 +- SCons/Tool/ar.xml | 10 +- SCons/Tool/as.xml | 10 +- SCons/Tool/bcc32.xml | 10 +- SCons/Tool/c++.xml | 10 +- SCons/Tool/cc.xml | 10 +- SCons/Tool/clang.xml | 10 +- SCons/Tool/clangxx.xml | 10 +- SCons/Tool/cvf.xml | 10 +- SCons/Tool/cyglink.xml | 10 +- SCons/Tool/default.xml | 10 +- SCons/Tool/dmd.xml | 10 +- SCons/Tool/docbook/__init__.xml | 10 +- SCons/Tool/dvi.xml | 10 +- SCons/Tool/dvipdf.xml | 10 +- SCons/Tool/dvips.xml | 10 +- SCons/Tool/f03.xml | 10 +- SCons/Tool/f08.xml | 10 +- SCons/Tool/f77.xml | 10 +- SCons/Tool/f90.xml | 10 +- SCons/Tool/f95.xml | 10 +- SCons/Tool/fortran.xml | 10 +- SCons/Tool/g++.xml | 10 +- SCons/Tool/g77.xml | 10 +- SCons/Tool/gas.xml | 10 +- SCons/Tool/gcc.xml | 10 +- SCons/Tool/gdc.xml | 10 +- SCons/Tool/gettext.xml | 10 +- SCons/Tool/gfortran.xml | 10 +- SCons/Tool/gnulink.xml | 10 +- SCons/Tool/gs.xml | 10 +- SCons/Tool/hpc++.xml | 10 +- SCons/Tool/hpcc.xml | 10 +- SCons/Tool/hplink.xml | 10 +- SCons/Tool/icc.xml | 10 +- SCons/Tool/icl.xml | 10 +- SCons/Tool/ifl.xml | 10 +- SCons/Tool/ifort.xml | 10 +- SCons/Tool/ilink.xml | 10 +- SCons/Tool/ilink32.xml | 10 +- SCons/Tool/install.xml | 10 +- SCons/Tool/intelc.xml | 10 +- SCons/Tool/jar.xml | 10 +- SCons/Tool/javac.xml | 10 +- SCons/Tool/javah.xml | 10 +- SCons/Tool/latex.xml | 10 +- SCons/Tool/ldc.xml | 10 +- SCons/Tool/lex.xml | 10 +- SCons/Tool/link.xml | 10 +- SCons/Tool/linkloc.xml | 10 +- SCons/Tool/m4.xml | 10 +- SCons/Tool/masm.xml | 10 +- SCons/Tool/midl.xml | 10 +- SCons/Tool/mingw.xml | 10 +- SCons/Tool/msgfmt.xml | 10 +- SCons/Tool/msginit.xml | 10 +- SCons/Tool/msgmerge.xml | 10 +- SCons/Tool/mslib.xml | 10 +- SCons/Tool/mslink.xml | 10 +- SCons/Tool/mssdk.xml | 10 +- SCons/Tool/msvc.xml | 10 +- SCons/Tool/msvs.xml | 10 +- SCons/Tool/mwcc.xml | 10 +- SCons/Tool/mwld.xml | 10 +- SCons/Tool/nasm.xml | 10 +- SCons/Tool/packaging.xml | 10 +- SCons/Tool/packaging/__init__.xml | 10 +- SCons/Tool/pdf.xml | 10 +- SCons/Tool/pdflatex.xml | 10 +- SCons/Tool/pdftex.xml | 10 +- SCons/Tool/python.xml | 10 +- SCons/Tool/qt.xml | 10 +- SCons/Tool/rmic.xml | 10 +- SCons/Tool/rpcgen.xml | 10 +- SCons/Tool/sgiar.xml | 10 +- SCons/Tool/sgic++.xml | 10 +- SCons/Tool/sgicc.xml | 10 +- SCons/Tool/sgilink.xml | 10 +- SCons/Tool/sunar.xml | 10 +- SCons/Tool/sunc++.xml | 10 +- SCons/Tool/suncc.xml | 10 +- SCons/Tool/sunf77.xml | 10 +- SCons/Tool/sunf90.xml | 10 +- SCons/Tool/sunf95.xml | 10 +- SCons/Tool/sunlink.xml | 10 +- SCons/Tool/swig.xml | 10 +- SCons/Tool/tar.xml | 10 +- SCons/Tool/tex.xml | 10 +- SCons/Tool/textfile.xml | 10 +- SCons/Tool/tlib.xml | 10 +- SCons/Tool/xgettext.xml | 10 +- SCons/Tool/yacc.xml | 10 +- SCons/Tool/zip.xml | 10 +- bin/SConsExamples.py | 6 +- bin/docs-update-generated.py | 2 +- bin/makedocs | 2 +- bin/scons-proc.py | 2 + doc/SConscript | 8 +- doc/design/SConstruct | 2 +- doc/design/chtml.xsl | 2 +- doc/design/html.xsl | 2 +- doc/design/pdf.xsl | 5 +- doc/developer/SConstruct | 2 +- doc/generated/builders.gen | 1474 ++--- doc/generated/examples/EnumVariable_map_1.xml | 3 +- doc/generated/examples/addmethod_ex1_1.xml | 3 +- doc/generated/examples/addmethod_ex2_1.xml | 3 +- doc/generated/examples/addmethod_ex2_2.xml | 3 +- doc/generated/examples/alias_ex1_1.xml | 3 +- doc/generated/examples/alias_ex2_1.xml | 3 +- doc/generated/examples/buildersbuiltin_ex1_1.xml | 3 +- doc/generated/examples/buildersbuiltin_ex2_1.xml | 3 +- doc/generated/examples/buildersbuiltin_ex3_1.xml | 3 +- doc/generated/examples/buildersbuiltin_ex4_1.xml | 3 +- doc/generated/examples/buildersbuiltin_libs_1.xml | 3 +- doc/generated/examples/buildersbuiltin_libs_2.xml | 3 +- doc/generated/examples/builderscommands_ex1_1.xml | 3 +- doc/generated/examples/builderscommands_ex2_1.xml | 3 +- .../examples/builderswriting_MY_EMITTER_1.xml | 3 +- doc/generated/examples/builderswriting_ex1_1.xml | 3 +- doc/generated/examples/builderswriting_ex2_1.xml | 3 +- doc/generated/examples/builderswriting_ex3_1.xml | 3 +- doc/generated/examples/builderswriting_ex4_1.xml | 3 +- doc/generated/examples/builderswriting_ex5_1.xml | 3 +- doc/generated/examples/builderswriting_ex6_1.xml | 3 +- doc/generated/examples/builderswriting_ex7_1.xml | 3 +- doc/generated/examples/caching_ex-random_1.xml | 7 +- doc/generated/examples/caching_ex1_1.xml | 3 +- doc/generated/examples/caching_ex1_2.xml | 3 +- doc/generated/examples/caching_ex1_4.xml | 3 +- doc/generated/examples/caching_ex1_5.xml | 3 +- doc/generated/examples/commandline_ARGLIST_1.xml | 3 +- doc/generated/examples/commandline_ARGUMENTS_1.xml | 3 +- doc/generated/examples/commandline_AddOption_1.xml | 3 +- doc/generated/examples/commandline_AddOption_2.xml | 3 +- .../examples/commandline_BUILD_TARGETS_1_1.xml | 3 +- .../examples/commandline_BoolVariable_1.xml | 3 +- .../examples/commandline_BoolVariable_2.xml | 3 +- .../examples/commandline_BoolVariable_3.xml | 3 +- .../examples/commandline_BoolVariable_4.xml | 3 +- .../examples/commandline_BoolVariable_5.xml | 5 +- .../commandline_COMMAND_LINE_TARGETS_1.xml | 3 +- .../examples/commandline_DEFAULT_TARGETS_1_1.xml | 3 +- .../examples/commandline_DEFAULT_TARGETS_2_1.xml | 3 +- doc/generated/examples/commandline_Default1_1.xml | 3 +- doc/generated/examples/commandline_Default1_2.xml | 3 +- doc/generated/examples/commandline_Default2_1.xml | 3 +- doc/generated/examples/commandline_Default3_1.xml | 3 +- doc/generated/examples/commandline_Default4_1.xml | 3 +- .../examples/commandline_EnumVariable_1.xml | 3 +- .../examples/commandline_EnumVariable_2.xml | 5 +- .../examples/commandline_EnumVariable_ic1_1.xml | 3 +- .../examples/commandline_EnumVariable_ic2_1.xml | 3 +- .../examples/commandline_ListVariable_1.xml | 3 +- .../examples/commandline_ListVariable_2.xml | 3 +- .../examples/commandline_ListVariable_3.xml | 5 +- .../examples/commandline_PackageVariable_1.xml | 3 +- .../examples/commandline_PathVariable_1.xml | 3 +- .../examples/commandline_PathVariable_2.xml | 5 +- .../examples/commandline_SCONSFLAGS_1.xml | 3 +- doc/generated/examples/commandline_SetOption_1.xml | 3 +- doc/generated/examples/commandline_SetOption_2.xml | 3 +- doc/generated/examples/commandline_SetOption_3.xml | 3 +- .../examples/commandline_UnknownVariables_1.xml | 5 +- .../examples/commandline_Variables1_1.xml | 3 +- .../examples/commandline_Variables_Help_1.xml | 3 +- .../commandline_Variables_custom_py_1_1.xml | 3 +- .../commandline_Variables_custom_py_2_1.xml | 3 +- doc/generated/examples/depends_AlwaysBuild_1.xml | 3 +- doc/generated/examples/depends_AlwaysBuild_2.xml | 3 +- doc/generated/examples/depends_Requires_1.xml | 3 +- doc/generated/examples/depends_ex1_1.xml | 3 +- doc/generated/examples/depends_ex1_2.xml | 3 +- doc/generated/examples/depends_ex1_3.xml | 3 +- doc/generated/examples/depends_ex1_4.xml | 3 +- doc/generated/examples/depends_ex1_5.xml | 3 +- doc/generated/examples/depends_ex1_6.xml | 3 +- doc/generated/examples/depends_ex1_7.xml | 3 +- doc/generated/examples/depends_ex1_8.xml | 3 +- doc/generated/examples/depends_ex5_1.xml | 3 +- doc/generated/examples/depends_ex5_2.xml | 3 +- .../examples/depends_ignore_explicit_1.xml | 3 +- doc/generated/examples/depends_include_1.xml | 3 +- doc/generated/examples/depends_macroinc_1.xml | 3 +- doc/generated/examples/depends_match_1.xml | 3 +- doc/generated/examples/depends_mixing_1.xml | 3 +- doc/generated/examples/depends_newer_1.xml | 3 +- doc/generated/examples/depends_no-Requires_1.xml | 3 +- doc/generated/examples/depends_parsedep_1.xml | 3 +- .../examples/environments_Append-nonexistent_1.xml | 3 +- .../environments_Prepend-nonexistent_1.xml | 3 +- .../environments_Replace-nonexistent_1.xml | 3 +- doc/generated/examples/environments_Replace1_1.xml | 3 +- doc/generated/examples/environments_Replace2_1.xml | 3 +- doc/generated/examples/environments_ex1_1.xml | 3 +- doc/generated/examples/environments_ex2_1.xml | 3 +- doc/generated/examples/environments_ex3_1.xml | 3 +- doc/generated/examples/environments_ex4_1.xml | 3 +- doc/generated/examples/environments_ex5_1.xml | 3 +- doc/generated/examples/environments_ex6_1.xml | 3 +- doc/generated/examples/environments_ex6b_1.xml | 3 +- doc/generated/examples/environments_ex6b_2.xml | 3 +- doc/generated/examples/environments_ex8_1.xml | 3 +- doc/generated/examples/environments_ex9_1.xml | 3 +- doc/generated/examples/environments_missing1_1.xml | 3 +- doc/generated/examples/environments_missing2_1.xml | 5 +- doc/generated/examples/environments_missing3_1.xml | 3 +- doc/generated/examples/factories_Chmod_1.xml | 3 +- doc/generated/examples/factories_Copy1_1.xml | 3 +- doc/generated/examples/factories_Copy2_1.xml | 3 +- doc/generated/examples/factories_Copy3_1.xml | 3 +- doc/generated/examples/factories_Delete1_1.xml | 3 +- doc/generated/examples/factories_Delete2_1.xml | 3 +- doc/generated/examples/factories_Execute_1.xml | 3 +- doc/generated/examples/factories_Mkdir_1.xml | 3 +- doc/generated/examples/factories_Move_1.xml | 3 +- doc/generated/examples/factories_Touch_1.xml | 3 +- doc/generated/examples/fileremoval_clean-ex1_1.xml | 3 +- .../examples/fileremoval_noclean-ex1_1.xml | 3 +- .../examples/fileremoval_precious-ex1_1.xml | 3 +- doc/generated/examples/hierarchy_Return_1.xml | 3 +- doc/generated/examples/hierarchy_ex1_1.xml | 3 +- doc/generated/examples/hierarchy_ex2_1.xml | 3 +- doc/generated/examples/hierarchy_ex3_1.xml | 3 +- doc/generated/examples/install_ex1_1.xml | 3 +- doc/generated/examples/install_ex2_1.xml | 3 +- doc/generated/examples/install_ex3_1.xml | 3 +- doc/generated/examples/install_ex4_1.xml | 3 +- doc/generated/examples/install_ex5_1.xml | 3 +- doc/generated/examples/java_JAVACLASSDIR_1.xml | 3 +- doc/generated/examples/java_RMIC_1.xml | 3 +- doc/generated/examples/java_jar1_1.xml | 3 +- doc/generated/examples/java_jar2_1.xml | 3 +- doc/generated/examples/java_java-classes_1.xml | 3 +- doc/generated/examples/java_java-classes_2.xml | 3 +- doc/generated/examples/java_java_1.xml | 3 +- doc/generated/examples/java_javah_1.xml | 3 +- doc/generated/examples/java_javah_file_1.xml | 3 +- doc/generated/examples/lesssimple_ex2_1.xml | 3 +- doc/generated/examples/lesssimple_ex3_1.xml | 3 +- doc/generated/examples/lesssimple_ex3_2.xml | 3 +- doc/generated/examples/lesssimple_ex4_1.xml | 3 +- doc/generated/examples/lesssimple_ex5_1.xml | 3 +- doc/generated/examples/lesssimple_target_1.xml | 3 +- doc/generated/examples/lesssimple_target_2.xml | 3 +- .../examples/libraries_SharedLibrary_1.xml | 3 +- .../examples/libraries_SharedLibrary_2.xml | 3 +- doc/generated/examples/libraries_ex1_1.xml | 3 +- doc/generated/examples/libraries_ex1_2.xml | 3 +- doc/generated/examples/libraries_ex2_1.xml | 3 +- doc/generated/examples/libraries_ex2_2.xml | 3 +- doc/generated/examples/libraries_ex3_1.xml | 3 +- doc/generated/examples/libraries_ex3_2.xml | 3 +- doc/generated/examples/libraries_objects_1.xml | 3 +- .../examples/mergeflags_MergeFlags1_1.xml | 3 +- .../examples/mergeflags_MergeFlags2_1.xml | 3 +- .../examples/mergeflags_MergeFlags3_1.xml | 3 +- doc/generated/examples/misc_Exit_1.xml | 3 +- doc/generated/examples/misc_FindFile1a_1.xml | 3 +- doc/generated/examples/misc_FindFile1b_1.xml | 3 +- doc/generated/examples/misc_FindFile1d_1.xml | 3 +- doc/generated/examples/misc_FindFile2_1.xml | 3 +- doc/generated/examples/misc_FindFile2_2.xml | 3 +- doc/generated/examples/misc_FindFile3_1.xml | 3 +- doc/generated/examples/misc_Flatten1_1.xml | 3 +- doc/generated/examples/misc_Flatten2_1.xml | 3 +- doc/generated/examples/nodes_GetBuildPath_1.xml | 3 +- doc/generated/examples/nodes_ex1_1.xml | 3 +- doc/generated/examples/nodes_ex1_2.xml | 3 +- doc/generated/examples/nodes_exists_1.xml | 3 +- doc/generated/examples/nodes_print_1.xml | 3 +- doc/generated/examples/nodes_print_2.xml | 3 +- .../examples/output_Progress-TARGET_1.xml | 3 +- doc/generated/examples/output_ex1_1.xml | 3 +- doc/generated/examples/output_ex2_1.xml | 3 +- doc/generated/examples/output_ex2_2.xml | 3 +- doc/generated/examples/output_gbf2_1.xml | 3 +- doc/generated/examples/parseflags_ex1_1.xml | 3 +- doc/generated/examples/parseflags_ex1_2.xml | 3 +- doc/generated/examples/parseflags_ex2_1.xml | 3 +- doc/generated/examples/parseflags_ex3_1.xml | 3 +- doc/generated/examples/parseflags_ex4_1.xml | 3 +- doc/generated/examples/repositories_CPPPATH3_1.xml | 3 +- doc/generated/examples/repositories_CPPPATH_1.xml | 3 +- doc/generated/examples/repositories_ex1_1.xml | 3 +- doc/generated/examples/repositories_ex2_1.xml | 3 +- doc/generated/examples/repositories_ex3_1.xml | 3 +- doc/generated/examples/repositories_ex4_1.xml | 3 +- doc/generated/examples/repositories_quote1_1.xml | 3 +- doc/generated/examples/separate_builddir_1.xml | 3 +- .../examples/separate_builddir_sconscript_1.xml | 3 +- doc/generated/examples/separate_duplicate0_1.xml | 3 +- doc/generated/examples/separate_ex1_1.xml | 3 +- .../separate_glob_builddir_sconscript_1.xml | 3 +- doc/generated/examples/sideeffect_parallel_1.xml | 3 +- doc/generated/examples/sideeffect_shared_1.xml | 3 +- doc/generated/examples/sideeffect_simple_1.xml | 3 +- doc/generated/examples/simple_Object_1.xml | 3 +- doc/generated/examples/simple_Object_2.xml | 3 +- doc/generated/examples/simple_clean_1.xml | 3 +- doc/generated/examples/simple_clean_2.xml | 3 +- doc/generated/examples/simple_declarative_1.xml | 3 +- doc/generated/examples/simple_ex1_1.xml | 3 +- doc/generated/examples/simple_ex1_2.xml | 3 +- doc/generated/examples/simple_ex1_3.xml | 3 +- doc/generated/examples/simple_ex1_4.xml | 3 +- doc/generated/examples/simple_java_1.xml | 3 +- doc/generated/examples/tasks_ex1_1.xml | 3 +- doc/generated/examples/troubleshoot_Dump_1.xml | 18 +- doc/generated/examples/troubleshoot_Dump_2.xml | 37 +- doc/generated/examples/troubleshoot_Dump_ENV_1.xml | 5 +- doc/generated/examples/troubleshoot_Dump_ENV_2.xml | 3 +- doc/generated/examples/troubleshoot_explain1_1.xml | 3 +- doc/generated/examples/troubleshoot_explain1_2.xml | 3 +- doc/generated/examples/troubleshoot_explain1_3.xml | 5 +- doc/generated/examples/troubleshoot_explain2_1.xml | 3 +- doc/generated/examples/troubleshoot_explain3_1.xml | 3 +- doc/generated/examples/troubleshoot_findlibs_1.xml | 3 +- .../examples/troubleshoot_stacktrace_1.xml | 3 +- .../examples/troubleshoot_stacktrace_2.xml | 8 +- .../examples/troubleshoot_taskmastertrace_1.xml | 3 +- doc/generated/examples/troubleshoot_tree1_1.xml | 3 +- doc/generated/examples/troubleshoot_tree2_1.xml | 3 +- doc/generated/examples/troubleshoot_tree2_2.xml | 3 +- doc/generated/examples/variants_ex_1.xml | 3 +- doc/generated/examples/variants_ex_2.xml | 3 +- doc/generated/functions.gen | 2289 +++---- doc/generated/functions.mod | 4 + doc/generated/tools.gen | 673 +-- doc/generated/variables.gen | 6392 +++++++++++--------- doc/generated/variables.mod | 22 +- doc/man/SConstruct | 2 +- doc/man/epub.xsl | 2 +- doc/man/html.xsl | 2 +- doc/man/pdf.xsl | 5 +- doc/python10/SConstruct | 2 +- doc/reference/SConstruct | 2 +- doc/reference/chtml.xsl | 2 +- doc/reference/html.xsl | 2 +- doc/reference/pdf.xsl | 5 +- doc/user/SConstruct | 2 +- doc/user/chtml.xsl | 2 +- doc/user/epub.xsl | 2 +- doc/user/html.xsl | 2 +- doc/user/pdf.xsl | 5 +- 363 files changed, 6303 insertions(+), 6471 deletions(-) diff --git a/SCons/Action.xml b/SCons/Action.xml index b519cdc..8263a57 100644 --- a/SCons/Action.xml +++ b/SCons/Action.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Defaults.xml b/SCons/Defaults.xml index 06fad1c..bd41cdf 100644 --- a/SCons/Defaults.xml +++ b/SCons/Defaults.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Environment.xml b/SCons/Environment.xml index ff3e385..d13d560 100644 --- a/SCons/Environment.xml +++ b/SCons/Environment.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Platform/__init__.xml b/SCons/Platform/__init__.xml index 4548e00..e877b1e 100644 --- a/SCons/Platform/__init__.xml +++ b/SCons/Platform/__init__.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Platform/posix.xml b/SCons/Platform/posix.xml index 4b2e0cd..b58af83 100644 --- a/SCons/Platform/posix.xml +++ b/SCons/Platform/posix.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Platform/sunos.xml b/SCons/Platform/sunos.xml index 6f912e3..a518301 100644 --- a/SCons/Platform/sunos.xml +++ b/SCons/Platform/sunos.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Platform/win32.xml b/SCons/Platform/win32.xml index 6face5f..e53f02a 100644 --- a/SCons/Platform/win32.xml +++ b/SCons/Platform/win32.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Scanner/__init__.xml b/SCons/Scanner/__init__.xml index a79d336..4f96d39 100644 --- a/SCons/Scanner/__init__.xml +++ b/SCons/Scanner/__init__.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Script/Main.xml b/SCons/Script/Main.xml index b54df0e..8092582 100644 --- a/SCons/Script/Main.xml +++ b/SCons/Script/Main.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Script/SConscript.xml b/SCons/Script/SConscript.xml index 8b88dca..9c383f8 100644 --- a/SCons/Script/SConscript.xml +++ b/SCons/Script/SConscript.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Subst.xml b/SCons/Subst.xml index 77372ce..4352de4 100644 --- a/SCons/Subst.xml +++ b/SCons/Subst.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/386asm.xml b/SCons/Tool/386asm.xml index 4c8d5a5..1661a87 100644 --- a/SCons/Tool/386asm.xml +++ b/SCons/Tool/386asm.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/DCommon.xml b/SCons/Tool/DCommon.xml index 6d907c6..a4efd7b 100644 --- a/SCons/Tool/DCommon.xml +++ b/SCons/Tool/DCommon.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/__init__.xml b/SCons/Tool/__init__.xml index b00e24e..5461d41 100644 --- a/SCons/Tool/__init__.xml +++ b/SCons/Tool/__init__.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/aixc++.xml b/SCons/Tool/aixc++.xml index bbbf4b9..91849ed 100644 --- a/SCons/Tool/aixc++.xml +++ b/SCons/Tool/aixc++.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/aixcc.xml b/SCons/Tool/aixcc.xml index f017e5a..a4d2855 100644 --- a/SCons/Tool/aixcc.xml +++ b/SCons/Tool/aixcc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/aixf77.xml b/SCons/Tool/aixf77.xml index e869625..89c2caa 100644 --- a/SCons/Tool/aixf77.xml +++ b/SCons/Tool/aixf77.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/aixlink.xml b/SCons/Tool/aixlink.xml index bf003ce..9032663 100644 --- a/SCons/Tool/aixlink.xml +++ b/SCons/Tool/aixlink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/applelink.xml b/SCons/Tool/applelink.xml index 977f2ce..c387500 100644 --- a/SCons/Tool/applelink.xml +++ b/SCons/Tool/applelink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/ar.xml b/SCons/Tool/ar.xml index 928a6fc..7ad54be 100644 --- a/SCons/Tool/ar.xml +++ b/SCons/Tool/ar.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/as.xml b/SCons/Tool/as.xml index 7c964a9..d38c608 100644 --- a/SCons/Tool/as.xml +++ b/SCons/Tool/as.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/bcc32.xml b/SCons/Tool/bcc32.xml index e043f0f..e2f1b46 100644 --- a/SCons/Tool/bcc32.xml +++ b/SCons/Tool/bcc32.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/c++.xml b/SCons/Tool/c++.xml index 019821c..6220e43 100644 --- a/SCons/Tool/c++.xml +++ b/SCons/Tool/c++.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/cc.xml b/SCons/Tool/cc.xml index e47cf2d..a7d6daa 100644 --- a/SCons/Tool/cc.xml +++ b/SCons/Tool/cc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/clang.xml b/SCons/Tool/clang.xml index 8751f97..2d989fa 100644 --- a/SCons/Tool/clang.xml +++ b/SCons/Tool/clang.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/clangxx.xml b/SCons/Tool/clangxx.xml index 32870ce..14582ad 100644 --- a/SCons/Tool/clangxx.xml +++ b/SCons/Tool/clangxx.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/cvf.xml b/SCons/Tool/cvf.xml index 580dea1..201d4af 100644 --- a/SCons/Tool/cvf.xml +++ b/SCons/Tool/cvf.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/cyglink.xml b/SCons/Tool/cyglink.xml index 702bff4..a1b4ec3 100644 --- a/SCons/Tool/cyglink.xml +++ b/SCons/Tool/cyglink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/default.xml b/SCons/Tool/default.xml index 9192e43..c729c1c 100644 --- a/SCons/Tool/default.xml +++ b/SCons/Tool/default.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/dmd.xml b/SCons/Tool/dmd.xml index 5d653bb..13284ec 100644 --- a/SCons/Tool/dmd.xml +++ b/SCons/Tool/dmd.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/docbook/__init__.xml b/SCons/Tool/docbook/__init__.xml index 32f085b..a774a2d 100644 --- a/SCons/Tool/docbook/__init__.xml +++ b/SCons/Tool/docbook/__init__.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/dvi.xml b/SCons/Tool/dvi.xml index d3d7328..3013bbc 100644 --- a/SCons/Tool/dvi.xml +++ b/SCons/Tool/dvi.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/dvipdf.xml b/SCons/Tool/dvipdf.xml index a2747bd..4ecc46e 100644 --- a/SCons/Tool/dvipdf.xml +++ b/SCons/Tool/dvipdf.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/dvips.xml b/SCons/Tool/dvips.xml index d19392a..f8c19c6 100644 --- a/SCons/Tool/dvips.xml +++ b/SCons/Tool/dvips.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/f03.xml b/SCons/Tool/f03.xml index 61c02ef..97de0ad 100644 --- a/SCons/Tool/f03.xml +++ b/SCons/Tool/f03.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/f08.xml b/SCons/Tool/f08.xml index a56d60b..3f91f3c 100644 --- a/SCons/Tool/f08.xml +++ b/SCons/Tool/f08.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/f77.xml b/SCons/Tool/f77.xml index 70ec721..ce69828 100644 --- a/SCons/Tool/f77.xml +++ b/SCons/Tool/f77.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/f90.xml b/SCons/Tool/f90.xml index 64dc6e1..c57c28b 100644 --- a/SCons/Tool/f90.xml +++ b/SCons/Tool/f90.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/f95.xml b/SCons/Tool/f95.xml index 4bda653..f628ab1 100644 --- a/SCons/Tool/f95.xml +++ b/SCons/Tool/f95.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/fortran.xml b/SCons/Tool/fortran.xml index 7b3c51f..560a484 100644 --- a/SCons/Tool/fortran.xml +++ b/SCons/Tool/fortran.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/g++.xml b/SCons/Tool/g++.xml index a871310..3bc3ec2 100644 --- a/SCons/Tool/g++.xml +++ b/SCons/Tool/g++.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/g77.xml b/SCons/Tool/g77.xml index 33596ab..40516ba 100644 --- a/SCons/Tool/g77.xml +++ b/SCons/Tool/g77.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gas.xml b/SCons/Tool/gas.xml index d71f38a..5a12401 100644 --- a/SCons/Tool/gas.xml +++ b/SCons/Tool/gas.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gcc.xml b/SCons/Tool/gcc.xml index 4d5374d..c22e00a 100644 --- a/SCons/Tool/gcc.xml +++ b/SCons/Tool/gcc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gdc.xml b/SCons/Tool/gdc.xml index b0fd89e..c5aed60 100644 --- a/SCons/Tool/gdc.xml +++ b/SCons/Tool/gdc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gettext.xml b/SCons/Tool/gettext.xml index aa30a7a..c7943b2 100644 --- a/SCons/Tool/gettext.xml +++ b/SCons/Tool/gettext.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gfortran.xml b/SCons/Tool/gfortran.xml index 0c9f40b..b5bad1a 100644 --- a/SCons/Tool/gfortran.xml +++ b/SCons/Tool/gfortran.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gnulink.xml b/SCons/Tool/gnulink.xml index 2fb9bba..c176c25 100644 --- a/SCons/Tool/gnulink.xml +++ b/SCons/Tool/gnulink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/gs.xml b/SCons/Tool/gs.xml index 44c9737..d05ea9f 100644 --- a/SCons/Tool/gs.xml +++ b/SCons/Tool/gs.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/hpc++.xml b/SCons/Tool/hpc++.xml index 97a8625..76c0979 100644 --- a/SCons/Tool/hpc++.xml +++ b/SCons/Tool/hpc++.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/hpcc.xml b/SCons/Tool/hpcc.xml index 85a60e1..85ce09e 100644 --- a/SCons/Tool/hpcc.xml +++ b/SCons/Tool/hpcc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/hplink.xml b/SCons/Tool/hplink.xml index 2aa7fe5..7cc02c6 100644 --- a/SCons/Tool/hplink.xml +++ b/SCons/Tool/hplink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/icc.xml b/SCons/Tool/icc.xml index f89df9f..8945091 100644 --- a/SCons/Tool/icc.xml +++ b/SCons/Tool/icc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/icl.xml b/SCons/Tool/icl.xml index 1f9ecaa..77edb8d 100644 --- a/SCons/Tool/icl.xml +++ b/SCons/Tool/icl.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/ifl.xml b/SCons/Tool/ifl.xml index 48c9b2e..693edcb 100644 --- a/SCons/Tool/ifl.xml +++ b/SCons/Tool/ifl.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/ifort.xml b/SCons/Tool/ifort.xml index 267f1bc..3f2768a 100644 --- a/SCons/Tool/ifort.xml +++ b/SCons/Tool/ifort.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/ilink.xml b/SCons/Tool/ilink.xml index 2941714..0ffdfd3 100644 --- a/SCons/Tool/ilink.xml +++ b/SCons/Tool/ilink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/ilink32.xml b/SCons/Tool/ilink32.xml index 07c5f9b..c8ecd26 100644 --- a/SCons/Tool/ilink32.xml +++ b/SCons/Tool/ilink32.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/install.xml b/SCons/Tool/install.xml index ce70d91..f4295a0 100644 --- a/SCons/Tool/install.xml +++ b/SCons/Tool/install.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/intelc.xml b/SCons/Tool/intelc.xml index 5404374..49a9296 100644 --- a/SCons/Tool/intelc.xml +++ b/SCons/Tool/intelc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/jar.xml b/SCons/Tool/jar.xml index 151dda1..1713495 100644 --- a/SCons/Tool/jar.xml +++ b/SCons/Tool/jar.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/javac.xml b/SCons/Tool/javac.xml index b1548c7..3ec7fea 100644 --- a/SCons/Tool/javac.xml +++ b/SCons/Tool/javac.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/javah.xml b/SCons/Tool/javah.xml index 5a2840f..ecbf782 100644 --- a/SCons/Tool/javah.xml +++ b/SCons/Tool/javah.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/latex.xml b/SCons/Tool/latex.xml index 9a2e2df..97451ec 100644 --- a/SCons/Tool/latex.xml +++ b/SCons/Tool/latex.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/ldc.xml b/SCons/Tool/ldc.xml index 6707f7e..5f3a3b2 100644 --- a/SCons/Tool/ldc.xml +++ b/SCons/Tool/ldc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/lex.xml b/SCons/Tool/lex.xml index 4e76c2a..5afb754 100644 --- a/SCons/Tool/lex.xml +++ b/SCons/Tool/lex.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/link.xml b/SCons/Tool/link.xml index 281e147..4eab92c 100644 --- a/SCons/Tool/link.xml +++ b/SCons/Tool/link.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/linkloc.xml b/SCons/Tool/linkloc.xml index 80849c9..2b5ba6a 100644 --- a/SCons/Tool/linkloc.xml +++ b/SCons/Tool/linkloc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/m4.xml b/SCons/Tool/m4.xml index 0e2c466..806d5fc 100644 --- a/SCons/Tool/m4.xml +++ b/SCons/Tool/m4.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/masm.xml b/SCons/Tool/masm.xml index c4ad409..25b9aae 100644 --- a/SCons/Tool/masm.xml +++ b/SCons/Tool/masm.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/midl.xml b/SCons/Tool/midl.xml index bee23e0..0845a81 100644 --- a/SCons/Tool/midl.xml +++ b/SCons/Tool/midl.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/mingw.xml b/SCons/Tool/mingw.xml index 80f9790..55e38b3 100644 --- a/SCons/Tool/mingw.xml +++ b/SCons/Tool/mingw.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/msgfmt.xml b/SCons/Tool/msgfmt.xml index a42a742..51424bc 100644 --- a/SCons/Tool/msgfmt.xml +++ b/SCons/Tool/msgfmt.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/msginit.xml b/SCons/Tool/msginit.xml index e494fbc..7017851 100644 --- a/SCons/Tool/msginit.xml +++ b/SCons/Tool/msginit.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/msgmerge.xml b/SCons/Tool/msgmerge.xml index 71dbe24..266ccc7 100644 --- a/SCons/Tool/msgmerge.xml +++ b/SCons/Tool/msgmerge.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/mslib.xml b/SCons/Tool/mslib.xml index 1837467..a79ec48 100644 --- a/SCons/Tool/mslib.xml +++ b/SCons/Tool/mslib.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/mslink.xml b/SCons/Tool/mslink.xml index 1691335..3de7d0d 100644 --- a/SCons/Tool/mslink.xml +++ b/SCons/Tool/mslink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/mssdk.xml b/SCons/Tool/mssdk.xml index aa61d0f..ec3c2ba 100644 --- a/SCons/Tool/mssdk.xml +++ b/SCons/Tool/mssdk.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/msvc.xml b/SCons/Tool/msvc.xml index e92fa9b..776c361 100644 --- a/SCons/Tool/msvc.xml +++ b/SCons/Tool/msvc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/msvs.xml b/SCons/Tool/msvs.xml index e6aa511..55f0401 100644 --- a/SCons/Tool/msvs.xml +++ b/SCons/Tool/msvs.xml @@ -6,15 +6,15 @@ This file is processed by the bin/SConsDoc.py module. See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/mwcc.xml b/SCons/Tool/mwcc.xml index 529ff1b..a0c6eda 100644 --- a/SCons/Tool/mwcc.xml +++ b/SCons/Tool/mwcc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/mwld.xml b/SCons/Tool/mwld.xml index 56d939c..60885b7 100644 --- a/SCons/Tool/mwld.xml +++ b/SCons/Tool/mwld.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/nasm.xml b/SCons/Tool/nasm.xml index f573d5a..0170b91 100644 --- a/SCons/Tool/nasm.xml +++ b/SCons/Tool/nasm.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/packaging.xml b/SCons/Tool/packaging.xml index 55fecec..c2b7087 100644 --- a/SCons/Tool/packaging.xml +++ b/SCons/Tool/packaging.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/packaging/__init__.xml b/SCons/Tool/packaging/__init__.xml index 37e97ff..03fd3e9 100644 --- a/SCons/Tool/packaging/__init__.xml +++ b/SCons/Tool/packaging/__init__.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/pdf.xml b/SCons/Tool/pdf.xml index 7bf44cc..8d73cbb 100644 --- a/SCons/Tool/pdf.xml +++ b/SCons/Tool/pdf.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/pdflatex.xml b/SCons/Tool/pdflatex.xml index 75eb4d4..883ddf4 100644 --- a/SCons/Tool/pdflatex.xml +++ b/SCons/Tool/pdflatex.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/pdftex.xml b/SCons/Tool/pdftex.xml index a8c7fd0..7e4941c 100644 --- a/SCons/Tool/pdftex.xml +++ b/SCons/Tool/pdftex.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/python.xml b/SCons/Tool/python.xml index 0e9fbbc..b1783ff 100644 --- a/SCons/Tool/python.xml +++ b/SCons/Tool/python.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/qt.xml b/SCons/Tool/qt.xml index cd54991..e0a2941 100644 --- a/SCons/Tool/qt.xml +++ b/SCons/Tool/qt.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/rmic.xml b/SCons/Tool/rmic.xml index e8b6c26..cc5755d 100644 --- a/SCons/Tool/rmic.xml +++ b/SCons/Tool/rmic.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/rpcgen.xml b/SCons/Tool/rpcgen.xml index f9142f1..0c314d0 100644 --- a/SCons/Tool/rpcgen.xml +++ b/SCons/Tool/rpcgen.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sgiar.xml b/SCons/Tool/sgiar.xml index edb7a60..131b5b3 100644 --- a/SCons/Tool/sgiar.xml +++ b/SCons/Tool/sgiar.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sgic++.xml b/SCons/Tool/sgic++.xml index a299d22..c9ab946 100644 --- a/SCons/Tool/sgic++.xml +++ b/SCons/Tool/sgic++.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sgicc.xml b/SCons/Tool/sgicc.xml index 82a84ec..df978b3 100644 --- a/SCons/Tool/sgicc.xml +++ b/SCons/Tool/sgicc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sgilink.xml b/SCons/Tool/sgilink.xml index ff54d89..54d22fe 100644 --- a/SCons/Tool/sgilink.xml +++ b/SCons/Tool/sgilink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sunar.xml b/SCons/Tool/sunar.xml index e267182..dfcf4ff 100644 --- a/SCons/Tool/sunar.xml +++ b/SCons/Tool/sunar.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sunc++.xml b/SCons/Tool/sunc++.xml index c671a5a..6eb7ea4 100644 --- a/SCons/Tool/sunc++.xml +++ b/SCons/Tool/sunc++.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/suncc.xml b/SCons/Tool/suncc.xml index 9c94e67..39d39f2 100644 --- a/SCons/Tool/suncc.xml +++ b/SCons/Tool/suncc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sunf77.xml b/SCons/Tool/sunf77.xml index dbcf7c3..7bcf33a 100644 --- a/SCons/Tool/sunf77.xml +++ b/SCons/Tool/sunf77.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sunf90.xml b/SCons/Tool/sunf90.xml index 627d58d..47544e0 100644 --- a/SCons/Tool/sunf90.xml +++ b/SCons/Tool/sunf90.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sunf95.xml b/SCons/Tool/sunf95.xml index 43c47e1..a08d62d 100644 --- a/SCons/Tool/sunf95.xml +++ b/SCons/Tool/sunf95.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/sunlink.xml b/SCons/Tool/sunlink.xml index b8544cc..dbcc8c7 100644 --- a/SCons/Tool/sunlink.xml +++ b/SCons/Tool/sunlink.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/swig.xml b/SCons/Tool/swig.xml index 46b45f4..19ec21f 100644 --- a/SCons/Tool/swig.xml +++ b/SCons/Tool/swig.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/tar.xml b/SCons/Tool/tar.xml index cf4022a..7f1011f 100644 --- a/SCons/Tool/tar.xml +++ b/SCons/Tool/tar.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/tex.xml b/SCons/Tool/tex.xml index da1bf20..eb4305a 100644 --- a/SCons/Tool/tex.xml +++ b/SCons/Tool/tex.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/textfile.xml b/SCons/Tool/textfile.xml index 878eb9f..962d966 100644 --- a/SCons/Tool/textfile.xml +++ b/SCons/Tool/textfile.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/tlib.xml b/SCons/Tool/tlib.xml index ee94717..8b1ea89 100644 --- a/SCons/Tool/tlib.xml +++ b/SCons/Tool/tlib.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/xgettext.xml b/SCons/Tool/xgettext.xml index 0493157..78afade 100644 --- a/SCons/Tool/xgettext.xml +++ b/SCons/Tool/xgettext.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/yacc.xml b/SCons/Tool/yacc.xml index 10817b0..c8e1bb4 100644 --- a/SCons/Tool/yacc.xml +++ b/SCons/Tool/yacc.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/SCons/Tool/zip.xml b/SCons/Tool/zip.xml index f465da1..8cf03f4 100644 --- a/SCons/Tool/zip.xml +++ b/SCons/Tool/zip.xml @@ -7,15 +7,15 @@ See its __doc__ string for a discussion of the format. --> + %scons; - + %builders-mod; - + %functions-mod; - + %tools-mod; - + %variables-mod; ]> diff --git a/bin/SConsExamples.py b/bin/SConsExamples.py index 063fba1..6223002 100644 --- a/bin/SConsExamples.py +++ b/bin/SConsExamples.py @@ -417,7 +417,7 @@ sys.path.append(os.path.join(os.getcwd(), 'build', 'testing/framework')) scons_py = os.path.join('scripts', 'scons.py') scons_py = os.path.join(os.getcwd(), scons_py) -scons_lib_dir = os.path.join(os.getcwd(), 'src', 'engine') +scons_lib_dir = os.path.join(os.getcwd(), 'SCons') os.environ['SCONS_LIB_DIR'] = scons_lib_dir @@ -825,7 +825,7 @@ def create_scons_output(e): # Massage file names in stack traces (sometimes reported as absolute # paths) to a consistent relative path. - engine_re = re.compile(r' File ".*/src/engine/SCons/') + engine_re = re.compile(r' File ".*/SCons/') # Python 2.5 changed the stack trace when the module is read # from standard input from read "... line 7, in ?" to @@ -873,7 +873,7 @@ def create_scons_output(e): if not command.output and lines: ncontent = '\n'.join(lines) ncontent = address_re.sub(r' at 0x700000>', ncontent) - ncontent = engine_re.sub(r' File "src/engine/SCons/', ncontent) + ncontent = engine_re.sub(r' File "SCons/', ncontent) ncontent = file_re.sub(r'\1 ', ncontent) ncontent = nodelist_re.sub(r"\1 'NodeList' object \2", ncontent) ncontent = ncontent.replace('__ROOT__', '') diff --git a/bin/docs-update-generated.py b/bin/docs-update-generated.py index 0a373aa..e26655a 100644 --- a/bin/docs-update-generated.py +++ b/bin/docs-update-generated.py @@ -27,7 +27,7 @@ def generate_all(): to generate the *.gen/*.mod files from it. """ flist = [] - for path, dirs, files in os.walk('src'): + for path, dirs, files in os.walk('SCons'): for f in files: if f.endswith('.xml'): fpath = os.path.join(path, f) diff --git a/bin/makedocs b/bin/makedocs index 2278a97..1c18453 100644 --- a/bin/makedocs +++ b/bin/makedocs @@ -9,7 +9,7 @@ if [ "$base" != "engine" ]; then exit fi -DEVDIR=../../doc/developer +DEVDIR=../doc/developer if [ ! -d $DEVDIR ]; then mkdir $DEVDIR fi diff --git a/bin/scons-proc.py b/bin/scons-proc.py index 30832a0..e4b73a2 100644 --- a/bin/scons-proc.py +++ b/bin/scons-proc.py @@ -115,6 +115,8 @@ class SCons_XML(object): self.write_mod(mod) def write_gen(self, filename): + print(f"DEBUG: write_gen({filename})") + print(f"values={self.values}") if not filename: return # Try to split off .gen filename diff --git a/doc/SConscript b/doc/SConscript index 6a522d0..4ab4200 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -223,7 +223,7 @@ else: # that all example names and example output suffixes are unique # print("Validating files against SCons XSD...") - if SConsDoc.validate_all_xml(['src'], xsdfile='xsd/scons.xsd'): + if SConsDoc.validate_all_xml(['SCons'], xsdfile='xsd/scons.xsd'): print("OK") else: print("Validation failed! Please correct the errors above and try again.") @@ -275,7 +275,7 @@ else: # # Copy DocBook stylesheets and Tool to the build folder # - dbtoolpath = ['src', 'engine', 'SCons', 'Tool', 'docbook'] + dbtoolpath = ['SCons', 'Tool', 'docbook'] copy_dbfiles(env, dbtoolpath, [], '__init__.py') copy_dbfiles(env, dbtoolpath, 'utils', 'xmldepend.xsl') dbpath = dbtoolpath + ['docbook-xsl-1.76.1'] @@ -291,7 +291,7 @@ else: # # Copy additional Tools (gs, zip) # - toolpath = ['src', 'engine', 'SCons', 'Tool'] + toolpath = ['SCons', 'Tool'] copy_dbfiles(env, toolpath, [], 'gs.py') copy_dbfiles(env, toolpath, [], 'zip.py') @@ -505,7 +505,7 @@ if not skip_doc: # XXX Should be in common with reading the same thing in # the SConstruct file. # bootstrap.py runs outside of SCons, so need to process the path - e = Dir(os.path.join('#src', 'engine')).rstr() + e = Dir('#').rstr() sources = bootstrap.parseManifestLines(e, os.path.join(e, 'MANIFEST.in')) # Omit some files: diff --git a/doc/design/SConstruct b/doc/design/SConstruct index d7ed6fe..0229eed 100644 --- a/doc/design/SConstruct +++ b/doc/design/SConstruct @@ -28,7 +28,7 @@ import os env = Environment(ENV={'PATH' : os.environ['PATH']}, tools=['docbook'], - toolpath=['../../src/engine/SCons/Tool'], + toolpath=['../../SCons/Tool'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') diff --git a/doc/design/chtml.xsl b/doc/design/chtml.xsl index dde3c6f..1051247 100644 --- a/doc/design/chtml.xsl +++ b/doc/design/chtml.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/design/html.xsl b/doc/design/html.xsl index 9efc458..4f2d383 100644 --- a/doc/design/html.xsl +++ b/doc/design/html.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/design/pdf.xsl b/doc/design/pdf.xsl index 33100d2..faea7fc 100644 --- a/doc/design/pdf.xsl +++ b/doc/design/pdf.xsl @@ -29,8 +29,9 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - - + + + diff --git a/doc/developer/SConstruct b/doc/developer/SConstruct index c97dc6c..bd1c904 100644 --- a/doc/developer/SConstruct +++ b/doc/developer/SConstruct @@ -28,7 +28,7 @@ import os env = Environment(ENV={'PATH' : os.environ['PATH']}, tools=['docbook'], - toolpath=['../../src/engine/SCons/Tool']) + toolpath=['../../SCons/Tool']) has_pdf = False if (env.WhereIs('fop') or diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 59d2dca..20e5215 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -1,4 +1,3 @@ - %scons; @@ -12,26 +11,21 @@ %variables-mod; ]> - + - - CFile() - - - env.CFile() - - - + CFile() + env.CFile() + Builds a C source file given a lex (.l) or yacc (.y) input file. -The suffix specified by the $CFILESUFFIX construction variable +The suffix specified by the $CFILESUFFIX construction variable (.c by default) is automatically added to the target if it is not already present. Example: - + # builds foo.c env.CFile(target = 'foo.c', source = 'foo.l') # builds bar.c @@ -40,15 +34,10 @@ env.CFile(target = 'bar', source = 'bar.y') - - Command() - - - env.Command() - - - -The Command "Builder" is actually + Command() + env.Command() + +The Command "Builder" is actually a function that looks like a Builder, but takes a required third argument, which is the action to take to construct the target @@ -56,31 +45,26 @@ from the source, used for "one-off" builds where a full builder is not needed. Thus it does not follow the builder calling rules described at the start of this section. -See instead the Command function description +See instead the Command function description for the calling syntax and details. - - CXXFile() - - - env.CXXFile() - - - + CXXFile() + env.CXXFile() + Builds a C++ source file given a lex (.ll) or yacc (.yy) input file. -The suffix specified by the $CXXFILESUFFIX construction variable +The suffix specified by the $CXXFILESUFFIX construction variable (.cc by default) is automatically added to the target if it is not already present. Example: - + # builds foo.cc env.CXXFile(target = 'foo.cc', source = 'foo.ll') # builds bar.cc @@ -89,151 +73,126 @@ env.CXXFile(target = 'bar', source = 'bar.yy') - - DocbookEpub() - - - env.DocbookEpub() - - - + DocbookEpub() + env.DocbookEpub() + A pseudo-Builder, providing a Docbook toolchain for EPUB output. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookEpub('manual.epub', 'manual.xml') - + or simply -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookEpub('manual') - - DocbookHtml() - - - env.DocbookHtml() - - - + DocbookHtml() + env.DocbookHtml() + A pseudo-Builder, providing a Docbook toolchain for HTML output. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtml('manual.html', 'manual.xml') - + or simply -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtml('manual') - - DocbookHtmlChunked() - - - env.DocbookHtmlChunked() - - - + DocbookHtmlChunked() + env.DocbookHtmlChunked() + A pseudo-Builder, providing a Docbook toolchain for chunked HTML output. It supports the base.dir parameter. The chunkfast.xsl file (requires "EXSLT") is used as the default stylesheet. Basic syntax: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlChunked('manual') - + where manual.xml is the input file. -If you use the root.filename +If you use the root.filename parameter in your own stylesheets you have to specify the new target name. This ensures that the dependencies get correct, especially for the cleanup via scons -c: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlChunked('mymanual.html', 'manual', xsl='htmlchunk.xsl') -Some basic support for the base.dir is provided. You +Some basic support for the base.dir is provided. You can add the base_dir keyword to your Builder call, and the given prefix gets prepended to all the created filenames: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlChunked('manual', xsl='htmlchunk.xsl', base_dir='output/') -Make sure that you don't forget the trailing slash for the base folder, else +Make sure that you don't forget the trailing slash for the base folder, else your files get renamed only! - - DocbookHtmlhelp() - - - env.DocbookHtmlhelp() - - - + DocbookHtmlhelp() + env.DocbookHtmlhelp() + A pseudo-Builder, providing a Docbook toolchain for HTMLHELP output. Its basic syntax is: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual') - + where manual.xml is the input file. -If you use the root.filename +If you use the root.filename parameter in your own stylesheets you have to specify the new target name. This ensures that the dependencies get correct, especially for the cleanup via scons -c: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlhelp('mymanual.html', 'manual', xsl='htmlhelp.xsl') -Some basic support for the base.dir parameter +Some basic support for the base.dir parameter is provided. You can add the base_dir keyword to your Builder call, and the given prefix gets prepended to all the created filenames: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual', xsl='htmlhelp.xsl', base_dir='output/') -Make sure that you don't forget the trailing slash for the base folder, else +Make sure that you don't forget the trailing slash for the base folder, else your files get renamed only! - - DocbookMan() - - - env.DocbookMan() - - - + DocbookMan() + env.DocbookMan() + A pseudo-Builder, providing a Docbook toolchain for Man page output. Its basic syntax is: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookMan('manual') - + where manual.xml is the input file. Note, that you can specify a target name, but the actual output names are automatically set from the refname entries in your XML source. @@ -241,175 +200,145 @@ set from the refname entries in your XML source. - - DocbookPdf() - - - env.DocbookPdf() - - - + DocbookPdf() + env.DocbookPdf() + A pseudo-Builder, providing a Docbook toolchain for PDF output. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookPdf('manual.pdf', 'manual.xml') - + or simply -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookPdf('manual') - - DocbookSlidesHtml() - - - env.DocbookSlidesHtml() - - - + DocbookSlidesHtml() + env.DocbookSlidesHtml() + A pseudo-Builder, providing a Docbook toolchain for HTML slides output. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookSlidesHtml('manual') -If you use the titlefoil.html parameter in +If you use the titlefoil.html parameter in your own stylesheets you have to give the new target name. This ensures that the dependencies get correct, especially for the cleanup via scons -c: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookSlidesHtml('mymanual.html','manual', xsl='slideshtml.xsl') -Some basic support for the base.dir parameter +Some basic support for the base.dir parameter is provided. You can add the base_dir keyword to your Builder call, and the given prefix gets prepended to all the created filenames: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookSlidesHtml('manual', xsl='slideshtml.xsl', base_dir='output/') -Make sure that you don't forget the trailing slash for the base folder, else +Make sure that you don't forget the trailing slash for the base folder, else your files get renamed only! - - DocbookSlidesPdf() - - - env.DocbookSlidesPdf() - - - + DocbookSlidesPdf() + env.DocbookSlidesPdf() + A pseudo-Builder, providing a Docbook toolchain for PDF slides output. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookSlidesPdf('manual.pdf', 'manual.xml') - + or simply -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookSlidesPdf('manual') - - DocbookXInclude() - - - env.DocbookXInclude() - - - + DocbookXInclude() + env.DocbookXInclude() + A pseudo-Builder, for resolving XIncludes in a separate processing step. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookXInclude('manual_xincluded.xml', 'manual.xml') - - DocbookXslt() - - - env.DocbookXslt() - - - + DocbookXslt() + env.DocbookXslt() + A pseudo-Builder, applying a given XSL transformation to the input file. -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookXslt('manual_transformed.xml', 'manual.xml', xsl='transform.xslt') -Note, that this builder requires the xsl parameter +Note, that this builder requires the xsl parameter to be set. - - DVI() - - - env.DVI() - - - + DVI() + env.DVI() + Builds a .dvi file from a .tex, .ltx or .latex input file. If the source file suffix is .tex, -scons +scons will examine the contents of the file; if the string \documentclass or \documentstyle is found, the file is assumed to be a LaTeX file and -the target is built by invoking the $LATEXCOM command line; -otherwise, the $TEXCOM command line is used. +the target is built by invoking the $LATEXCOM command line; +otherwise, the $TEXCOM command line is used. If the file is a LaTeX file, the -DVI +DVI builder method will also examine the contents of the .aux -file and invoke the $BIBTEX command line +file and invoke the $BIBTEX command line if the string bibdata is found, -start $MAKEINDEX to generate an index if a +start $MAKEINDEX to generate an index if a .ind file is found and will examine the contents .log -file and re-run the $LATEXCOM command +file and re-run the $LATEXCOM command if the log file says it is necessary. - + The suffix .dvi (hard-coded within TeX itself) is automatically added to the target @@ -417,7 +346,7 @@ if it is not already present. Examples: - + # builds from aaa.tex env.DVI(target = 'aaa.dvi', source = 'aaa.tex') # builds bbb.dvi @@ -428,20 +357,15 @@ env.DVI(target = 'ccc.dvi', source = 'ccc.latex') - - Gs() - - - env.Gs() - - - + Gs() + env.Gs() + A Builder for explicitly calling the gs executable. Depending on the underlying OS, the different names gs, gsos2 and gswin32c are tried. -env = Environment(tools=['gs']) +env = Environment(tools=['gs']) env.Gs('cover.jpg','scons-scons.pdf', GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -q') ) @@ -449,14 +373,9 @@ env.Gs('cover.jpg','scons-scons.pdf', - - Install() - - - env.Install() - - - + Install() + env.Install() + Installs one or more source files or directories in the specified target, which must be a directory. @@ -466,11 +385,25 @@ sources may be given as a string or as a node returned by a builder. - -env.Install('/usr/local/bin', source = ['foo', 'bar']) + +env.Install(target='/usr/local/bin', source=['foo', 'bar']) - + +Note that if target paths chosen for the +Install builder (and the related InstallAs and +InstallVersionedLib builders) are outside the +project tree, such as in the example above, +they may not be selected for "building" by default, +since in the absence of other instructions +scons builds targets that are underneath the top directory +(the directory that contains the SConstruct file, +usually the current directory). +Use command line targets or the Default function +in this case. + + + If the command line option is given, the target directory will be prefixed by the directory path specified. @@ -478,8 +411,8 @@ This is useful to test installs without installing to a "live" location in the system. - -See also FindInstalledFiles. + +See also FindInstalledFiles. For more thoughts on installation, see the User Guide (particularly the section on Command-Line Targets and the chapters on Installing Files and on Alias Targets). @@ -488,14 +421,9 @@ and the chapters on Installing Files and on Alias Targets). - - InstallAs() - - - env.InstallAs() - - - + InstallAs() + env.InstallAs() + Installs one or more source files or directories to specific names, allowing changing a file or directory name @@ -507,76 +435,75 @@ 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']) + +env.InstallAs(target='/usr/local/bin/foo', + source='foo_debug') +env.InstallAs(target=['../lib/libfoo.a', '../lib/libbar.a'], + source=['libFOO.a', 'libBAR.a']) + +See the note under Install. + + - - InstallVersionedLib() - - - env.InstallVersionedLib() - - - + InstallVersionedLib() + env.InstallVersionedLib() + Installs a versioned shared library. The symlinks appropriate to the architecture will be generated based on symlinks of the source library. - -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') + + +See the note under Install. + + - - Jar() - - - env.Jar() - - - + Jar() + env.Jar() + Builds a Java archive (.jar) file from the specified list of sources. Any directories in the source list will be searched for .class files). Any .java files in the source list will be compiled to .class files -by calling the Java Builder. +by calling the Java Builder. - -If the $JARCHDIR value is set, the -jar + +If the $JARCHDIR value is set, the +jar command will change to the specified directory using the option. -If $JARCHDIR is not set explicitly, -SCons will use the top of any subdirectory tree +If $JARCHDIR is not set explicitly, +SCons will use the top of any subdirectory tree in which Java .class -were built by the Java Builder. +were built by the Java Builder. - + If the contents any of the source files begin with the string Manifest-Version, the file is assumed to be a manifest and is passed to the -jar +jar command with the option set. - + env.Jar(target = 'foo.jar', source = 'classes') env.Jar(target = 'bar.jar', @@ -585,14 +512,9 @@ env.Jar(target = 'bar.jar', - - Java() - - - env.Java() - - - + Java() + env.Java() + Builds one or more Java class files. The sources may be any combination of explicit .java @@ -601,7 +523,7 @@ env.Jar(target = 'bar.jar', for .java files. - + SCons will parse each source .java file to find the classes (including inner classes) @@ -612,7 +534,7 @@ env.Jar(target = 'bar.jar', 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 @@ -635,17 +557,17 @@ env.Jar(target = 'bar.jar', 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']) + +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, @@ -658,21 +580,16 @@ env.Jar(target = 'bar.jar', with a different encoding. - - env = Environment() - env['ENV']['LANG'] = 'en_GB.UTF-8' + +env = Environment() +env['ENV']['LANG'] = 'en_GB.UTF-8' - - JavaH() - - - env.JavaH() - - - + JavaH() + env.JavaH() + Builds C header and source files for implementing Java native methods. The target can be either a directory @@ -682,87 +599,73 @@ will contain all of the definitions. The source can be the names of .class files, the names of .java files to be compiled into .class files -by calling the Java builder method, +by calling the Java builder method, or the objects returned from the -Java +Java builder method. - + If the construction variable -$JAVACLASSDIR +$JAVACLASSDIR is set, either in the environment or in the call to the -JavaH +JavaH builder method itself, then the value of the variable will be stripped from the beginning of any .class file names. - + Examples: - + # builds java_native.h -classes = env.Java(target = 'classdir', source = 'src') -env.JavaH(target = 'java_native.h', source = classes) +classes = env.Java(target="classdir", source="src") +env.JavaH(target="java_native.h", source=classes) # builds include/package_foo.h and include/package_bar.h -env.JavaH(target = 'include', - source = ['package/foo.class', 'package/bar.class']) +env.JavaH(target="include", source=["package/foo.class", "package/bar.class"]) # builds export/foo.h and export/bar.h -env.JavaH(target = 'export', - source = ['classes/foo.class', 'classes/bar.class'], - JAVACLASSDIR = 'classes') +env.JavaH( + target="export", + source=["classes/foo.class", "classes/bar.class"], + JAVACLASSDIR="classes", +) - - Library() - - - env.Library() - - - + Library() + env.Library() + A synonym for the -StaticLibrary +StaticLibrary builder method. - - LoadableModule() - - - env.LoadableModule() - - - + LoadableModule() + env.LoadableModule() + On most systems, this is the same as -SharedLibrary. +SharedLibrary. On Mac OS X (Darwin) platforms, this creates a loadable module bundle. - - M4() - - - env.M4() - - - + M4() + env.M4() + Builds an output file from an M4 input file. -This uses a default $M4FLAGS value of +This uses a default $M4FLAGS value of , which considers all warnings to be fatal and stops on the first warning @@ -770,81 +673,71 @@ when using the GNU version of m4. Example: - + env.M4(target = 'foo.c', source = 'foo.c.m4') - - Moc() - - - env.Moc() - - - + Moc() + env.Moc() + Builds an output file from a moc input file. Moc input files are either header files or cxx files. This builder is only available after using the -tool 'qt'. See the $QTDIR variable for more information. +tool 'qt'. See the $QTDIR variable for more information. Example: - + env.Moc('foo.h') # generates moc_foo.cc env.Moc('foo.cpp') # generates foo.moc - - MOFiles() - - - env.MOFiles() - - - -This builder belongs to msgfmt tool. The builder compiles + MOFiles() + env.MOFiles() + +This builder belongs to msgfmt tool. The builder compiles PO files to MO files. - + Example 1. Create pl.mo and en.mo by compiling pl.po and en.po: - + # ... env.MOFiles(['pl', 'en']) - + Example 2. Compile files for languages defined in LINGUAS file: - + # ... env.MOFiles(LINGUAS_FILE = 1) - + Example 3. Create pl.mo and en.mo by compiling pl.po and en.po plus files for languages defined in LINGUAS file: - + # ... env.MOFiles(['pl', 'en'], LINGUAS_FILE = 1) - + Example 4. Compile files for languages defined in LINGUAS file (another version): - + # ... env['LINGUAS_FILE'] = 1 env.MOFiles() @@ -852,60 +745,55 @@ Compile files for languages defined in LINGUAS file - - MSVSProject() - - - env.MSVSProject() - - - + MSVSProject() + 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 + $MSVS_VERSION in the Environment constructor). For Visual Studio 6, it will generate a .dsp 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 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 + 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 + + 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 + $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 @@ -913,7 +801,7 @@ Compile files for languages defined in LINGUAS file The name of the target .dsp or .vcproj file. The correct suffix for the version of Visual Studio - must be used, but the $MSVSPROJECTSUFFIX + must be used, but the $MSVSPROJECTSUFFIX construction variable will be defined to the correct value (see example below). @@ -931,7 +819,7 @@ Compile files for languages defined in LINGUAS file 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; + to MSVSProject with different variants are allowed; all variants will be added to the project file with their appropriate build targets and sources. @@ -966,6 +854,25 @@ Compile files for languages defined in LINGUAS file + cppflags + + + Compiler flags for the different variants. + If a /std:c++ flag is found then /Zc:__cplusplus is + appended to the flags if not already found, this + ensures that intellisense uses the /std:c++ switch. + The number of cppflags 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 combine the invoking environment's + CCFLAGS, CXXFLAGS, + CPPFLAGS entries for all variants. + + + + cpppaths @@ -1007,20 +914,20 @@ Compile files for languages defined in LINGUAS file - - Note that because SCons always executes its build commands - from the directory in which the SConstruct file is located, + + 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 + 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 + 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: - + Example usage: + barsrcs = ['bar.cpp'] barincs = ['bar.h'] barlocalincs = ['StdAfx.h'] @@ -1039,13 +946,13 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], 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 @@ -1061,7 +968,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], - + 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 @@ -1070,11 +977,11 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], 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') @@ -1192,32 +1099,27 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], - - MSVSSolution() - - - env.MSVSSolution() - - - Builds a Microsoft Visual Studio solution file. - + MSVSSolution() + 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 + $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: - + 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 + but the value $MSVSSOLUTIONSUFFIX will be defined to the correct value (see example below). @@ -1236,7 +1138,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], projects A list of project file names, or Project nodes returned - by calls to the MSVSProject Builder, to be placed + 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. @@ -1247,111 +1149,105 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], - Example Usage: - -env.MSVSSolution(target='Bar' + env['MSVSSOLUTIONSUFFIX'], projects=['bar' + env['MSVSPROJECTSUFFIX']], variant='Release') + Example Usage: + +env.MSVSSolution( + target="Bar" + env["MSVSSOLUTIONSUFFIX"], + projects=["bar" + env["MSVSPROJECTSUFFIX"]], + variant="Release", +) - - Object() - - - env.Object() - - - + Object() + env.Object() + A synonym for the -StaticObject +StaticObject builder method. - - Package() - - - env.Package() - - - -Builds a Binary Package of the given source files. - - - + Package() + env.Package() + +Builds a Binary Package of the given source files. + + + env.Package(source = FindInstalledFiles()) - - + Builds software distribution packages. Packages consist of files to install and packaging information. -The former may be specified with the source parameter and may be left out, -in which case the FindInstalledFiles function will collect -all files that have an Install or InstallAs Builder attached. -If the target is not specified +The former may be specified with the source parameter and may be left out, +in which case the FindInstalledFiles function will collect +all files that have an Install or InstallAs Builder attached. +If the target is not specified it will be deduced from additional information given to this Builder. - + The packaging information is specified with the help of construction variables documented below. This information is called a tag to stress that -some of them can also be attached to files with the Tag function. +some of them can also be attached to files with the Tag function. The mandatory ones will complain if they were not specified. They vary depending on chosen target packager. - + The target packager may be selected with the "PACKAGETYPE" command line -option or with the $PACKAGETYPE construction variable. Currently +option or with the $PACKAGETYPE construction variable. Currently the following packagers available: - - * msi - Microsoft Installer - * rpm - RPM Package Manger - * ipkg - Itsy Package Management System - * tarbz2 - bzip2 compressed tar - * targz - gzip compressed tar - * tarxz - xz compressed tar - * zip - zip file - * src_tarbz2 - bzip2 compressed tar source - * src_targz - gzip compressed tar source - * src_tarxz - xz compressed tar source - * src_zip - zip file source - - - -An updated list is always available under the "package_type" option when -running "scons --help" on a project that has packaging activated. - - -env = Environment(tools=['default', 'packaging']) -env.Install('/bin/', 'my_program') -env.Package( NAME = 'foo', - VERSION = '1.2.3', - PACKAGEVERSION = 0, - PACKAGETYPE = 'rpm', - LICENSE = 'gpl', - SUMMARY = 'balalalalal', - DESCRIPTION = 'this should be really really long', - X_RPM_GROUP = 'Application/fu', - SOURCE_URL = 'http://foo.org/foo-1.2.3.tar.gz' - ) +
+ +msi - Microsoft Installer +rpm - RPM Package Manger +ipkg - Itsy Package Management System +tarbz2 - bzip2 compressed tar +targz - gzip compressed tar +tarxz - xz compressed tar +zip - zip file +src_tarbz2 - bzip2 compressed tar source +src_targz - gzip compressed tar source +src_tarxz - xz compressed tar source +src_zip - zip file source + +
+ + +An updated list is always available under the +package_type option when +running scons --help +on a project that has packaging activated. + + + +env = Environment(tools=["default", "packaging"]) +env.Install("/bin/", "my_program") +env.Package( + NAME="foo", + VERSION="1.2.3", + PACKAGEVERSION=0, + PACKAGETYPE="rpm", + LICENSE="gpl", + SUMMARY="balalalalal", + DESCRIPTION="this should be really really long", + X_RPM_GROUP="Application/fu", + SOURCE_URL="http://foo.org/foo-1.2.3.tar.gz", +) - - PCH() - - - env.PCH() - - - + PCH() + env.PCH() + Builds a Microsoft Visual C++ precompiled header. Calling this builder method returns a list of two targets: the PCH as the first element, and the object @@ -1363,33 +1259,28 @@ conjunction with the PCH construction variable to force object files to use the precompiled header: - + env['PCH'] = env.PCH('StdAfx.cpp')[0] - - PDF() - - - env.PDF() - - - + PDF() + env.PDF() + Builds a .pdf file from a .dvi input file (or, by extension, a .tex, .ltx, or .latex input file). -The suffix specified by the $PDFSUFFIX construction variable +The suffix specified by the $PDFSUFFIX construction variable (.pdf by default) is added automatically to the target if it is not already present. Example: - + # builds from aaa.tex env.PDF(target = 'aaa.pdf', source = 'aaa.tex') # builds bbb.pdf from bbb.dvi @@ -1398,133 +1289,123 @@ env.PDF(target = 'bbb', source = 'bbb.dvi') - - POInit() - - - env.POInit() - - - -This builder belongs to msginit tool. The builder initializes missing -PO file(s) if $POAUTOINIT is set. If -$POAUTOINIT is not set (default), POInit prints instruction for + POInit() + env.POInit() + +This builder belongs to msginit tool. The builder initializes missing +PO file(s) if $POAUTOINIT is set. If +$POAUTOINIT is not set (default), POInit prints instruction for user (that is supposed to be a translator), telling how the PO file should be initialized. In normal projects -you should not use POInit and use POUpdate -instead. POUpdate chooses intelligently between -msgmerge(1) and msginit(1). POInit +you should not use POInit and use POUpdate +instead. POUpdate chooses intelligently between +msgmerge(1) and msginit(1). POInit always uses msginit(1) and should be regarded as builder for special purposes or for temporary use (e.g. for quick, one time initialization of a bunch of PO files) or for tests. - -Target nodes defined through POInit are not built by default (they're + +Target nodes defined through POInit are not built by default (they're Ignored from '.' node) but are added to special Alias ('po-create' by default). -The alias name may be changed through the $POCREATE_ALIAS +The alias name may be changed through the $POCREATE_ALIAS construction variable. All PO files defined through -POInit may be easily initialized by scons po-create. +POInit may be easily initialized by scons po-create. - + Example 1. Initialize en.po and pl.po from messages.pot: - + # ... env.POInit(['en', 'pl']) # messages.pot --> [en.po, pl.po] - + Example 2. Initialize en.po and pl.po from foo.pot: - + # ... env.POInit(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.po] - + Example 3. Initialize en.po and pl.po from -foo.pot but using $POTDOMAIN construction +foo.pot but using $POTDOMAIN construction variable: - + # ... env.POInit(['en', 'pl'], POTDOMAIN='foo') # foo.pot --> [en.po, pl.po] - + Example 4. Initialize PO files for languages defined in LINGUAS file. The files will be initialized from template messages.pot: - + # ... env.POInit(LINGUAS_FILE = 1) # needs 'LINGUAS' file - + Example 5. Initialize en.po and pl.pl PO files plus files for languages defined in LINGUAS file. The files will be initialized from template messages.pot: - + # ... env.POInit(['en', 'pl'], LINGUAS_FILE = 1) - + Example 6. You may preconfigure your environment first, and then initialize PO files: - + # ... env['POAUTOINIT'] = 1 env['LINGUAS_FILE'] = 1 env['POTDOMAIN'] = 'foo' env.POInit() - + which has same efect as: - + # ... env.POInit(POAUTOINIT = 1, LINGUAS_FILE = 1, POTDOMAIN = 'foo') - - PostScript() - - - env.PostScript() - - - + PostScript() + env.PostScript() + Builds a .ps file from a .dvi input file (or, by extension, a .tex, .ltx, or .latex input file). -The suffix specified by the $PSSUFFIX construction variable +The suffix specified by the $PSSUFFIX construction variable (.ps by default) is added automatically to the target if it is not already present. Example: - + # builds from aaa.tex env.PostScript(target = 'aaa.ps', source = 'aaa.tex') # builds bbb.ps from bbb.dvi @@ -1533,30 +1414,25 @@ env.PostScript(target = 'bbb', source = 'bbb.dvi') - - POTUpdate() - - - env.POTUpdate() - - - -The builder belongs to xgettext tool. The builder updates target + POTUpdate() + env.POTUpdate() + +The builder belongs to xgettext tool. The builder updates target POT file if exists or creates one if it doesn't. The node is not built by default (i.e. it is Ignored from '.'), but only on demand (i.e. when given POT file is required or when special alias is invoked). This builder adds its targe node (messages.pot, say) to a special alias (pot-update by default, see -$POTUPDATE_ALIAS) so you can update/create them easily with +$POTUPDATE_ALIAS) so you can update/create them easily with scons pot-update. The file is not written until there is no real change in internationalized messages (or in comments that enter POT file). - + You may see xgettext(1) being invoked by the -xgettext tool even if there is no real change in internationalized +xgettext tool even if there is no real change in internationalized messages (so the POT file is not being updated). This happens every time a source file has changed. In such case we invoke xgettext(1) and compare its output with the content of @@ -1564,38 +1440,38 @@ happens every time a source file has changed. In such case we invoke not. - + Example 1. Let's create po/ directory and place following SConstruct script there: - + # SConstruct in 'po/' subdir env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(['foo'], ['../a.cpp', '../b.cpp']) env.POTUpdate(['bar'], ['../c.cpp', '../d.cpp']) - + Then invoke scons few times: - + user@host:$ scons # Does not create foo.pot nor bar.pot user@host:$ scons foo.pot # Updates or creates foo.pot user@host:$ scons pot-update # Updates or creates foo.pot and bar.pot user@host:$ scons -c # Does not clean foo.pot nor bar.pot. - + the results shall be as the comments above say. - + Example 2. -The POTUpdate builder may be used with no target specified, in which +The POTUpdate builder may be used with no target specified, in which case default target messages.pot will be used. The -default target may also be overridden by setting $POTDOMAIN construction -variable or providing it as an override to POTUpdate builder: +default target may also be overridden by setting $POTDOMAIN construction +variable or providing it as an override to POTUpdate builder: - + # SConstruct script env = Environment( tools = ['default', 'xgettext'] ) env['POTDOMAIN'] = "foo" @@ -1603,49 +1479,49 @@ variable or providing it as an override to - + Example 3. The sources may be specified within separate file, for example POTFILES.in: - + # POTFILES.in in 'po/' subdirectory ../a.cpp ../b.cpp # end of file - + The name of the file (POTFILES.in) containing the list of -sources is provided via $XGETTEXTFROM: +sources is provided via $XGETTEXTFROM: - + # SConstruct file in 'po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in') - + Example 4. -You may use $XGETTEXTPATH to define source search path. Assume, for +You may use $XGETTEXTPATH to define source search path. Assume, for example, that you have files a.cpp, b.cpp, po/SConstruct, po/POTFILES.in. Then your POT-related files could look as below: - + # POTFILES.in in 'po/' subdirectory a.cpp b.cpp # end of file - + # SConstruct file in 'po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH='../') - + Example 5. Multiple search directories may be defined within a list, i.e. XGETTEXTPATH = ['dir1', 'dir2', ...]. The order in the list @@ -1653,48 +1529,48 @@ determines the search order of source files. The path to the first file found is used. - + Let's create 0/1/po/SConstruct script: - + # SConstruct file in '0/1/po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../', '../../']) - + and 0/1/po/POTFILES.in: - + # POTFILES.in in '0/1/po/' subdirectory a.cpp # end of file - + Write two *.cpp files, the first one is 0/a.cpp: - + /* 0/a.cpp */ gettext("Hello from ../../a.cpp") - + and the second is 0/1/a.cpp: - + /* 0/1/a.cpp */ gettext("Hello from ../a.cpp") - + then run scons. You'll obtain 0/1/po/messages.pot with the message "Hello from ../a.cpp". When you reverse order in $XGETTEXTFOM, i.e. when you write SConscript as - + # SConstruct file in '0/1/po/' subdirectory env = Environment( tools = ['default', 'xgettext'] ) env.POTUpdate(XGETTEXTFROM = 'POTFILES.in', XGETTEXTPATH=['../../', '../']) - + then the messages.pot will contain msgid "Hello from ../../a.cpp" line and not msgid "Hello from ../a.cpp". @@ -1703,113 +1579,108 @@ then the messages.pot will contain - - POUpdate() - - - env.POUpdate() - - - -The builder belongs to msgmerge tool. The builder updates + POUpdate() + env.POUpdate() + +The builder belongs to msgmerge tool. The builder updates PO files with msgmerge(1), or initializes missing PO files as described in documentation of -msginit tool and POInit builder (see also -$POAUTOINIT). Note, that POUpdate does not add its -targets to po-create alias as POInit +msginit tool and POInit builder (see also +$POAUTOINIT). Note, that POUpdate does not add its +targets to po-create alias as POInit does. - -Target nodes defined through POUpdate are not built by default + +Target nodes defined through POUpdate are not built by default (they're Ignored from '.' node). Instead, they are added automatically to special Alias ('po-update' by default). The alias name may be changed -through the $POUPDATE_ALIAS construction variable. You can easily +through the $POUPDATE_ALIAS construction variable. You can easily update PO files in your project by scons po-update. - + Example 1. Update en.po and pl.po from -messages.pot template (see also $POTDOMAIN), +messages.pot template (see also $POTDOMAIN), assuming that the later one exists or there is rule to build it (see -POTUpdate): +POTUpdate): - + # ... env.POUpdate(['en','pl']) # messages.pot --> [en.po, pl.po] - + Example 2. Update en.po and pl.po from foo.pot template: - + # ... env.POUpdate(['en', 'pl'], ['foo']) # foo.pot --> [en.po, pl.pl] - + Example 3. Update en.po and pl.po from foo.pot (another version): - + # ... env.POUpdate(['en', 'pl'], POTDOMAIN='foo') # foo.pot -- > [en.po, pl.pl] - + Example 4. Update files for languages defined in LINGUAS file. The files are updated from messages.pot template: - + # ... env.POUpdate(LINGUAS_FILE = 1) # needs 'LINGUAS' file - + Example 5. Same as above, but update from foo.pot template: - + # ... env.POUpdate(LINGUAS_FILE = 1, source = ['foo']) - + Example 6. Update en.po and pl.po plus files for languages defined in LINGUAS file. The files are updated from messages.pot template: - + # produce 'en.po', 'pl.po' + files defined in 'LINGUAS': env.POUpdate(['en', 'pl' ], LINGUAS_FILE = 1) - + Example 7. -Use $POAUTOINIT to automatically initialize PO file +Use $POAUTOINIT to automatically initialize PO file if it doesn't exist: - + # ... env.POUpdate(LINGUAS_FILE = 1, POAUTOINIT = 1) - + Example 8. Update PO files for languages defined in LINGUAS file. The files are updated from foo.pot template. All necessary settings are pre-configured via environment. - + # ... env['POAUTOINIT'] = 1 env['LINGUAS_FILE'] = 1 @@ -1820,63 +1691,53 @@ pre-configured via environment. - - Program() - - - env.Program() - - - + Program() + env.Program() + Builds an executable given one or more object files or C, C++, D, or Fortran source files. If any C, C++, D or Fortran source files are specified, then they will be automatically compiled to object files using the -Object +Object builder method; see that builder method's description for a list of legal source file suffixes and how they are interpreted. The target executable file prefix -(specified by the $PROGPREFIX construction variable; nothing by default) +(specified by the $PROGPREFIX construction variable; nothing by default) and suffix -(specified by the $PROGSUFFIX construction variable; +(specified by the $PROGSUFFIX construction variable; by default, .exe on Windows systems, nothing on POSIX systems) are automatically added to the target if not already present. Example: - + env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) - - ProgramAllAtOnce() - - - env.ProgramAllAtOnce() - - - + ProgramAllAtOnce() + env.ProgramAllAtOnce() + Builds an executable from D sources without first creating individual objects for each file. - + D sources can be compiled file-by-file as C and C++ source are, and - D is integrated into the scons Object and Program builders for + D is integrated into the scons Object and Program builders for this model of build. D codes can though do whole source meta-programming (some of the testing frameworks do this). For this it is imperative that all sources are compiled and linked in a single call to the D compiler. This builder serves that purpose. - + env.ProgramAllAtOnce('executable', ['mod_a.d, mod_b.d', 'mod_c.d']) - + This command will compile the modules mod_a, mod_b, and mod_c in a single compilation process without first creating object files for the modules. Some of the D compilers will create executable.o others @@ -1885,14 +1746,9 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) - - RES() - - - env.RES() - - - + RES() + env.RES() + Builds a Microsoft Visual C++ resource file. This builder method is only provided when Microsoft Visual C++ or MinGW is being used as the compiler. The @@ -1905,20 +1761,15 @@ file is scanned for implicit dependencies as though it were a C file. Example: - + env.RES('resource.rc') - - RMIC() - - - env.RMIC() - - - + RMIC() + env.RMIC() + Builds stub and skeleton class files for remote objects from Java .class files. @@ -1927,16 +1778,16 @@ relative to which the stub and skeleton class files will be written. The source can be the names of .class files, or the objects return from the -Java +Java builder method. - + If the construction variable -$JAVACLASSDIR +$JAVACLASSDIR is set, either in the environment or in the call to the -RMIC +RMIC builder method itself, then the value of the variable will be stripped from the @@ -1944,7 +1795,7 @@ beginning of any .class file names. - + classes = env.Java(target = 'classdir', source = 'src') env.RMIC(target = 'outdir1', source = classes) @@ -1958,14 +1809,9 @@ env.RMIC(target = 'outdir3', - - RPCGenClient() - - - env.RPCGenClient() - - - + RPCGenClient() + env.RPCGenClient() + Generates an RPC client stub (_clnt.c) file from a specified RPC (.x) source file. Because rpcgen only builds output files @@ -1974,21 +1820,16 @@ the command will be executed in the source file's directory by default. - + # Builds src/rpcif_clnt.c env.RPCGenClient('src/rpcif.x') - - RPCGenHeader() - - - env.RPCGenHeader() - - - + RPCGenHeader() + env.RPCGenHeader() + Generates an RPC header (.h) file from a specified RPC (.x) source file. Because rpcgen only builds output files @@ -1997,21 +1838,16 @@ the command will be executed in the source file's directory by default. - + # Builds src/rpcif.h env.RPCGenHeader('src/rpcif.x') - - RPCGenService() - - - env.RPCGenService() - - - + RPCGenService() + env.RPCGenService() + Generates an RPC server-skeleton (_svc.c) file from a specified RPC (.x) source file. Because rpcgen only builds output files @@ -2020,21 +1856,16 @@ the command will be executed in the source file's directory by default. - + # Builds src/rpcif_svc.c env.RPCGenClient('src/rpcif.x') - - RPCGenXDR() - - - env.RPCGenXDR() - - - + RPCGenXDR() + env.RPCGenXDR() + Generates an RPC XDR routine (_xdr.c) file from a specified RPC (.x) source file. Because rpcgen only builds output files @@ -2043,21 +1874,16 @@ the command will be executed in the source file's directory by default. - + # Builds src/rpcif_xdr.c env.RPCGenClient('src/rpcif.x') - - SharedLibrary() - - - env.SharedLibrary() - - - + SharedLibrary() + env.SharedLibrary() + Builds a shared library (.so on a POSIX system, .dll on Windows) @@ -2069,24 +1895,24 @@ compiled to object files. The static library prefix and suffix (if any) are automatically added to the target. The target library file prefix -(specified by the $SHLIBPREFIX construction variable; +(specified by the $SHLIBPREFIX construction variable; by default, lib on POSIX systems, nothing on Windows systems) and suffix -(specified by the $SHLIBSUFFIX construction variable; +(specified by the $SHLIBSUFFIX construction variable; by default, .dll on Windows systems, .so on POSIX systems) are automatically added to the target if not already present. Example: - + env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o']) - + On Windows systems, the -SharedLibrary +SharedLibrary builder method will always build an import (.lib) library in addition to the shared (.dll) library, @@ -2095,9 +1921,9 @@ if there is not already a .lib file explicitly listed in the targets. - + On Cygwin systems, the -SharedLibrary +SharedLibrary builder method will always build an import (.dll.a) library in addition to the shared (.dll) library, @@ -2106,36 +1932,36 @@ if there is not already a .dll.a file explicitly listed in the targets. - + Any object files listed in the source must have been built for a shared library (that is, using the -SharedObject +SharedObject builder method). -scons +scons will raise an error if there is any mismatch. - + On some platforms, there is a distinction between a shared library (loaded automatically by the system to resolve external references) and a loadable module (explicitly loaded by user action). -For maximum portability, use the LoadableModule builder for the latter. +For maximum portability, use the LoadableModule builder for the latter. - -When the $SHLIBVERSION construction variable is defined a versioned -shared library is created. This modifies the $SHLINKFLAGS as required, + +When the $SHLIBVERSION construction variable is defined a versioned +shared library is created. This modifies the $SHLINKFLAGS as required, adds the version number to the library name, and creates the symlinks that are needed. - + env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o'], SHLIBVERSION='1.5.2') - + On a POSIX system, versions with a single token create exactly one symlink: libbar.so.6 would have symlinks libbar.so only. On a POSIX system, versions with two or more @@ -2144,47 +1970,42 @@ libbar.so and libbar.so.2; on a Darwin (OSX) system the library would be libbar.2.3.1.dylib and the link would be libbar.dylib. - + On Windows systems, specifying register=1 will cause the .dll to be registered after it is built using REGSVR32. The command that is run -("regsvr32" by default) is determined by $REGSVR construction -variable, and the flags passed are determined by $REGSVRFLAGS. By -default, $REGSVRFLAGS includes the option, +("regsvr32" by default) is determined by $REGSVR construction +variable, and the flags passed are determined by $REGSVRFLAGS. By +default, $REGSVRFLAGS includes the option, to prevent dialogs from popping up and requiring user attention when it is run. If you change -$REGSVRFLAGS, be sure to include the option. +$REGSVRFLAGS, be sure to include the option. For example, - + env.SharedLibrary(target = 'bar', source = ['bar.cxx', 'foo.obj'], register=1) - + will register bar.dll as a COM object when it is done linking it. - - SharedObject() - - - env.SharedObject() - - - + SharedObject() + env.SharedObject() + Builds an object file for inclusion in a shared library. Source files must have one of the same set of extensions specified above for the -StaticObject +StaticObject builder method. On some platforms building a shared object requires additional compiler option @@ -2199,21 +2020,21 @@ and shared objects to be linked into a shared library, and will use the same suffix for shared and normal (static) objects. The target object file prefix -(specified by the $SHOBJPREFIX construction variable; -by default, the same as $OBJPREFIX) +(specified by the $SHOBJPREFIX construction variable; +by default, the same as $OBJPREFIX) and suffix -(specified by the $SHOBJSUFFIX construction variable) +(specified by the $SHOBJSUFFIX construction variable) are automatically added to the target if not already present. Examples: - + env.SharedObject(target = 'ddd', source = 'ddd.c') env.SharedObject(target = 'eee.o', source = 'eee.cpp') env.SharedObject(target = 'fff.obj', source = 'fff.for') - + Note that the source files will be scanned according to the suffix mappings in the SourceFileScanner @@ -2224,14 +2045,9 @@ below, for more information. - - StaticLibrary() - - - env.StaticLibrary() - - - + StaticLibrary() + env.StaticLibrary() + Builds a static library given one or more object files or C, C++, D or Fortran source files. If any source files are given, @@ -2240,48 +2056,43 @@ compiled to object files. The static library prefix and suffix (if any) are automatically added to the target. The target library file prefix -(specified by the $LIBPREFIX construction variable; +(specified by the $LIBPREFIX construction variable; by default, lib on POSIX systems, nothing on Windows systems) and suffix -(specified by the $LIBSUFFIX construction variable; +(specified by the $LIBSUFFIX construction variable; by default, .lib on Windows systems, .a on POSIX systems) are automatically added to the target if not already present. Example: - + env.StaticLibrary(target = 'bar', source = ['bar.c', 'foo.o']) - + Any object files listed in the source must have been built for a static library (that is, using the -StaticObject +StaticObject builder method). -scons +scons will raise an error if there is any mismatch. - - StaticObject() - - - env.StaticObject() - - - + StaticObject() + env.StaticObject() + Builds a static object file from one or more C, C++, D, or Fortran source files. Source files must have one of the following extensions: - + .asm assembly language file .ASM assembly language file .c C file @@ -2312,24 +2123,24 @@ Source files must have one of the following extensions: .SPP assembly language file + C pre-processor - + The target object file prefix -(specified by the $OBJPREFIX construction variable; nothing by default) +(specified by the $OBJPREFIX construction variable; nothing by default) and suffix -(specified by the $OBJSUFFIX construction variable; +(specified by the $OBJSUFFIX construction variable; .obj on Windows systems, .o on POSIX systems) are automatically added to the target if not already present. Examples: - + env.StaticObject(target = 'aaa', source = 'aaa.c') env.StaticObject(target = 'bbb.o', source = 'bbb.c++') env.StaticObject(target = 'ccc.obj', source = 'ccc.f') - + Note that the source files will be scanned according to the suffix mappings in SourceFileScanner @@ -2340,34 +2151,29 @@ below, for more information. - - Substfile() - - - env.Substfile() - - - -The Substfile builder creates a single text file from another file or set of -files by concatenating them with $LINESEPARATOR and replacing text -using the $SUBST_DICT construction variable. Nested lists of source files -are flattened. See also Textfile. - - - + Substfile() + env.Substfile() + +The Substfile builder creates a single text file from another file or set of +files by concatenating them with $LINESEPARATOR and replacing text +using the $SUBST_DICT construction variable. Nested lists of source files +are flattened. See also Textfile. + + + If a single source file is present with an .in suffix, the suffix is stripped and the remainder is used as the default target name. - -The prefix and suffix specified by the $SUBSTFILEPREFIX -and $SUBSTFILESUFFIX construction variables -(the null string by default in both cases) + +The prefix and suffix specified by the $SUBSTFILEPREFIX +and $SUBSTFILESUFFIX construction variables +(an empty string by default in both cases) are automatically added to the target if they are not already present. - -If a construction variable named $SUBST_DICT is present, + +If a construction variable named $SUBST_DICT is present, it may be either a Python dictionary or a sequence of (key,value) tuples. If it is a dictionary it is converted into a list of tuples in an arbitrary order, so if one key is a prefix of another key @@ -2375,7 +2181,7 @@ or if one substitution could be further expanded by another subsitition, it is unpredictable whether the expansion will occur. - + Any occurrences of a key in the source are replaced by the corresponding value, which may be a Python callable function or a string. @@ -2384,7 +2190,7 @@ Strings are subst-expanded and the result replaces the key. - + env = Environment(tools=['default']) env['prefix'] = '/usr/bin' @@ -2430,19 +2236,14 @@ subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'), - - Tar() - - - env.Tar() - - - + Tar() + env.Tar() + Builds a tar archive of the specified files and/or directories. Unlike most builder methods, the -Tar +Tar builder method may be called multiple times for a given target; each additional call @@ -2452,11 +2253,11 @@ Any source directories will be scanned for changes to any on-disk files, regardless of whether or not -scons +scons knows about them from other Builder or function calls. - + env.Tar('src.tar', 'src') # Create the stuff.tar file. @@ -2476,35 +2277,30 @@ env.Tar('foo') - - Textfile() - - - env.Textfile() - - - -The Textfile builder generates a single text file. + Textfile() + env.Textfile() + +The Textfile builder generates a single text file. The source strings constitute the lines; nested lists of sources are flattened. -$LINESEPARATOR is used to separate the strings. +$LINESEPARATOR is used to separate the strings. - -If present, the $SUBST_DICT construction variable + +If present, the $SUBST_DICT construction variable is used to modify the strings before they are written; -see the Substfile description for details. +see the Substfile description for details. - -The prefix and suffix specified by the $TEXTFILEPREFIX -and $TEXTFILESUFFIX construction variables -(the null string and .txt by default, respectively) + +The prefix and suffix specified by the $TEXTFILEPREFIX +and $TEXTFILESUFFIX construction variables +(an empty string and .txt by default, respectively) are automatically added to the target if they are not already present. Examples: - + # builds/writes foo.txt env.Textfile(target = 'foo.txt', source = ['Goethe', 42, 'Schiller']) @@ -2547,56 +2343,51 @@ blob.txt - - Translate() - - - env.Translate() - - - -This pseudo-builder belongs to gettext toolset. The builder extracts + Translate() + env.Translate() + +This pseudo-builder belongs to gettext toolset. The builder extracts internationalized messages from source files, updates POT template (if necessary) and then updates PO translations (if -necessary). If $POAUTOINIT is set, missing PO files +necessary). If $POAUTOINIT is set, missing PO files will be automatically created (i.e. without translator person intervention). -The variables $LINGUAS_FILE and $POTDOMAIN are taken into -acount too. All other construction variables used by POTUpdate, and -POUpdate work here too. +The variables $LINGUAS_FILE and $POTDOMAIN are taken into +acount too. All other construction variables used by POTUpdate, and +POUpdate work here too. - + Example 1. The simplest way is to specify input files and output languages inline in -a SCons script when invoking Translate +a SCons script when invoking Translate - + # SConscript in 'po/' directory env = Environment( tools = ["default", "gettext"] ) env['POAUTOINIT'] = 1 env.Translate(['en','pl'], ['../a.cpp','../b.cpp']) - + Example 2. If you wish, you may also stick to conventional style known from autotools, i.e. using POTFILES.in and LINGUAS files - + # LINGUAS en pl #end - + # POTFILES.in a.cpp b.cpp # end - + # SConscript env = Environment( tools = ["default", "gettext"] ) env['POAUTOINIT'] = 1 @@ -2604,7 +2395,7 @@ env['XGETTEXTPATH'] = ['../'] env.Translate(LINGUAS_FILE = 1, XGETTEXTFROM = 'POTFILES.in') - + The last approach is perhaps the recommended one. It allows easily split internationalization/localization onto separate SCons scripts, where a script in source tree is responsible for translations (from sources to @@ -2621,11 +2412,11 @@ so the source tree looks familiar to translators, and they may work with the project in their usual way. - + Example 3. Let's prepare a development tree as below - + project/ + SConstruct + build/ @@ -2636,11 +2427,11 @@ Let's prepare a development tree as below + POTFILES.in + LINGUAS - + with build being variant directory. Write the top-level SConstruct script as follows - + # SConstruct env = Environment( tools = ["default", "gettext"] ) VariantDir('build', 'src', duplicate = 0) @@ -2648,23 +2439,23 @@ with build being variant directory. Write the top-level SConscript('src/po/SConscript.i18n', exports = 'env') SConscript('build/po/SConscript', exports = 'env') - + the src/po/SConscript.i18n as - + # src/po/SConscript.i18n Import('env') env.Translate(LINGUAS_FILE=1, XGETTEXTFROM='POTFILES.in', XGETTEXTPATH=['../']) - + and the src/po/SConscript - + # src/po/SConscript Import('env') env.MOFiles(LINGUAS_FILE = 1) - + Such setup produces POT and PO files under source tree in src/po/ and binary MO files under variant tree in @@ -2674,7 +2465,7 @@ not be committed back to source repositories (e.g. MO files). - + In above example, the PO files are not updated, nor created automatically when you issue scons '.' command. The files must be updated (created) by hand via scons @@ -2685,14 +2476,9 @@ running scons '.'. - - TypeLibrary() - - - env.TypeLibrary() - - - + TypeLibrary() + env.TypeLibrary() + Builds a Windows type library (.tlb) file from an input IDL file (.idl). In addition, it will build the associated interface stub and @@ -2701,11 +2487,11 @@ naming them according to the base name of the .idl file. For example, - + env.TypeLibrary(source="foo.idl") - + Will create foo.tlb, foo.h, foo_i.c, @@ -2717,28 +2503,23 @@ files. - - Uic() - - - env.Uic() - - - + Uic() + env.Uic() + Builds a header file, an implementation file and a moc file from an ui file. and returns the corresponding nodes in the above order. This builder is only available after using the tool 'qt'. Note: you can specify .ui files directly as source -files to the Program, -Library and SharedLibrary builders +files to the Program, +Library and SharedLibrary builders without using this builder. Using this builder lets you override the standard naming conventions (be careful: prefixes are always prepended to names of built files; if you don't want prefixes, you may set them to ``). -See the $QTDIR variable for more information. +See the $QTDIR variable for more information. Example: - + env.Uic('foo.ui') # -> ['foo.h', 'uic_foo.cc', 'moc_foo.cc'] env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), source = 'foo.ui') # -> ['include/foo.h', 'gen/uicfoo.cc', 'gen/mocfoo.cc'] @@ -2746,19 +2527,14 @@ env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), - - Zip() - - - env.Zip() - - - + Zip() + env.Zip() + Builds a zip archive of the specified files and/or directories. Unlike most builder methods, the -Zip +Zip builder method may be called multiple times for a given target; each additional call @@ -2768,11 +2544,11 @@ Any source directories will be scanned for changes to any on-disk files, regardless of whether or not -scons +scons knows about them from other Builder or function calls. - + env.Zip('src.zip', 'src') # Create the stuff.zip file. diff --git a/doc/generated/examples/EnumVariable_map_1.xml b/doc/generated/examples/EnumVariable_map_1.xml index 4380be0..856731e 100644 --- a/doc/generated/examples/EnumVariable_map_1.xml +++ b/doc/generated/examples/EnumVariable_map_1.xml @@ -1,4 +1,3 @@ - -% scons -Q COLOR=navy foo.o +% scons -Q COLOR=navy foo.o cc -o foo.o -c -DCOLOR="blue" foo.c diff --git a/doc/generated/examples/addmethod_ex1_1.xml b/doc/generated/examples/addmethod_ex1_1.xml index 84dfd20..5cacf9d 100644 --- a/doc/generated/examples/addmethod_ex1_1.xml +++ b/doc/generated/examples/addmethod_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q / +% scons -Q / cc -o hello.o -c hello.c cc -o hello hello.o Install file: "hello" as "/usr/bin/hello" diff --git a/doc/generated/examples/addmethod_ex2_1.xml b/doc/generated/examples/addmethod_ex2_1.xml index 3930341..4d0cb44 100644 --- a/doc/generated/examples/addmethod_ex2_1.xml +++ b/doc/generated/examples/addmethod_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o test_stuff.o -c test_stuff.c cc -o tests/test_stuff test_stuff.o diff --git a/doc/generated/examples/addmethod_ex2_2.xml b/doc/generated/examples/addmethod_ex2_2.xml index 734da63..7ad282f 100644 --- a/doc/generated/examples/addmethod_ex2_2.xml +++ b/doc/generated/examples/addmethod_ex2_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q rc /nologo /fores.res res.rc cl /Fotest_stuff.obj /c test_stuff.c /nologo link /nologo /OUT:tests\test_stuff.exe test_stuff.obj res.res diff --git a/doc/generated/examples/alias_ex1_1.xml b/doc/generated/examples/alias_ex1_1.xml index 3ee3f1b..d0db114 100644 --- a/doc/generated/examples/alias_ex1_1.xml +++ b/doc/generated/examples/alias_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q install +% scons -Q install cc -o hello.o -c hello.c cc -o hello hello.o Install file: "hello" as "/usr/bin/hello" diff --git a/doc/generated/examples/alias_ex2_1.xml b/doc/generated/examples/alias_ex2_1.xml index 3fa7dfd..56cc365 100644 --- a/doc/generated/examples/alias_ex2_1.xml +++ b/doc/generated/examples/alias_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q install-bin +% scons -Q install-bin cc -o foo.o -c foo.c cc -o foo foo.o Install file: "foo" as "/usr/bin/foo" diff --git a/doc/generated/examples/buildersbuiltin_ex1_1.xml b/doc/generated/examples/buildersbuiltin_ex1_1.xml index 74cc779..75b365d 100644 --- a/doc/generated/examples/buildersbuiltin_ex1_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q . +% scons -Q . tar -c -f out1.tar file1 file2 tar -c -f out2.tar directory diff --git a/doc/generated/examples/buildersbuiltin_ex2_1.xml b/doc/generated/examples/buildersbuiltin_ex2_1.xml index 6c66d7b..88abed4 100644 --- a/doc/generated/examples/buildersbuiltin_ex2_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex2_1.xml @@ -1,4 +1,3 @@ - -% scons -Q . +% scons -Q . tar -c -z -f out.tar.gz directory diff --git a/doc/generated/examples/buildersbuiltin_ex3_1.xml b/doc/generated/examples/buildersbuiltin_ex3_1.xml index 4d281e5..5cb16d1 100644 --- a/doc/generated/examples/buildersbuiltin_ex3_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex3_1.xml @@ -1,4 +1,3 @@ - -% scons -Q . +% scons -Q . tar -c -z -f out.tgz directory diff --git a/doc/generated/examples/buildersbuiltin_ex4_1.xml b/doc/generated/examples/buildersbuiltin_ex4_1.xml index 856f024..e907422 100644 --- a/doc/generated/examples/buildersbuiltin_ex4_1.xml +++ b/doc/generated/examples/buildersbuiltin_ex4_1.xml @@ -1,4 +1,3 @@ - -% scons -Q . +% scons -Q . zip(["out.zip"], ["file1", "file2"]) diff --git a/doc/generated/examples/buildersbuiltin_libs_1.xml b/doc/generated/examples/buildersbuiltin_libs_1.xml index 8e1ee49..5b7abd9 100644 --- a/doc/generated/examples/buildersbuiltin_libs_1.xml +++ b/doc/generated/examples/buildersbuiltin_libs_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o goodbye.o -c goodbye.c cc -o hello.o -c hello.c cc -o hello hello.o goodbye.o -L/usr/dir1 -Ldir2 -lfoo1 -lfoo2 diff --git a/doc/generated/examples/buildersbuiltin_libs_2.xml b/doc/generated/examples/buildersbuiltin_libs_2.xml index 41a9c1e..31f3a46 100644 --- a/doc/generated/examples/buildersbuiltin_libs_2.xml +++ b/doc/generated/examples/buildersbuiltin_libs_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fogoodbye.obj /c goodbye.c /nologo cl /Fohello.obj /c hello.c /nologo link /nologo /OUT:hello.exe /LIBPATH:\usr\dir1 /LIBPATH:dir2 foo1.lib foo2.lib hello.obj goodbye.obj diff --git a/doc/generated/examples/builderscommands_ex1_1.xml b/doc/generated/examples/builderscommands_ex1_1.xml index 8782773..470b5a4 100644 --- a/doc/generated/examples/builderscommands_ex1_1.xml +++ b/doc/generated/examples/builderscommands_ex1_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q sed 's/x/y/' < foo.in > foo.out diff --git a/doc/generated/examples/builderscommands_ex2_1.xml b/doc/generated/examples/builderscommands_ex2_1.xml index 3fc1dde..1593352 100644 --- a/doc/generated/examples/builderscommands_ex2_1.xml +++ b/doc/generated/examples/builderscommands_ex2_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q build(["foo.out"], ["foo.in"]) diff --git a/doc/generated/examples/builderswriting_MY_EMITTER_1.xml b/doc/generated/examples/builderswriting_MY_EMITTER_1.xml index 0c17d0e..ef831e5 100644 --- a/doc/generated/examples/builderswriting_MY_EMITTER_1.xml +++ b/doc/generated/examples/builderswriting_MY_EMITTER_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q ./my_command file1.input modify1.in > file1.foo ./my_command file2.input modify2.in > file2.foo diff --git a/doc/generated/examples/builderswriting_ex1_1.xml b/doc/generated/examples/builderswriting_ex1_1.xml index cefcfa2..1c6379a 100644 --- a/doc/generated/examples/builderswriting_ex1_1.xml +++ b/doc/generated/examples/builderswriting_ex1_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q foobuild < file.input > file.foo diff --git a/doc/generated/examples/builderswriting_ex2_1.xml b/doc/generated/examples/builderswriting_ex2_1.xml index 445dfb0..e86ee7b 100644 --- a/doc/generated/examples/builderswriting_ex2_1.xml +++ b/doc/generated/examples/builderswriting_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q AttributeError: 'SConsEnvironment' object has no attribute 'Program': File "/home/my/project/SConstruct", line 4: env.Program('hello.c') diff --git a/doc/generated/examples/builderswriting_ex3_1.xml b/doc/generated/examples/builderswriting_ex3_1.xml index 2d8bcac..8e107c8 100644 --- a/doc/generated/examples/builderswriting_ex3_1.xml +++ b/doc/generated/examples/builderswriting_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q foobuild < file.input > file.foo cc -o hello.o -c hello.c cc -o hello hello.o diff --git a/doc/generated/examples/builderswriting_ex4_1.xml b/doc/generated/examples/builderswriting_ex4_1.xml index cc71b19..f3ecd43 100644 --- a/doc/generated/examples/builderswriting_ex4_1.xml +++ b/doc/generated/examples/builderswriting_ex4_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q foobuild < file1.input > file1.foo foobuild < file2.input > file2.foo diff --git a/doc/generated/examples/builderswriting_ex5_1.xml b/doc/generated/examples/builderswriting_ex5_1.xml index d0aa83b..e7e9097 100644 --- a/doc/generated/examples/builderswriting_ex5_1.xml +++ b/doc/generated/examples/builderswriting_ex5_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q build_function(["file.foo"], ["file.input"]) diff --git a/doc/generated/examples/builderswriting_ex6_1.xml b/doc/generated/examples/builderswriting_ex6_1.xml index cefcfa2..1c6379a 100644 --- a/doc/generated/examples/builderswriting_ex6_1.xml +++ b/doc/generated/examples/builderswriting_ex6_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q foobuild < file.input > file.foo diff --git a/doc/generated/examples/builderswriting_ex7_1.xml b/doc/generated/examples/builderswriting_ex7_1.xml index f14d598..88284fe 100644 --- a/doc/generated/examples/builderswriting_ex7_1.xml +++ b/doc/generated/examples/builderswriting_ex7_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q foobuild file.foo new_target - file.input new_source diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml index 1c99727..52ad77d 100644 --- a/doc/generated/examples/caching_ex-random_1.xml +++ b/doc/generated/examples/caching_ex-random_1.xml @@ -1,9 +1,8 @@ - -% scons -Q +% scons -Q cc -o f3.o -c f3.c -cc -o f4.o -c f4.c -cc -o f1.o -c f1.c cc -o f2.o -c f2.c +cc -o f1.o -c f1.c cc -o f5.o -c f5.c +cc -o f4.o -c f4.c cc -o prog f1.o f2.o f3.o f4.o f5.o diff --git a/doc/generated/examples/caching_ex1_1.xml b/doc/generated/examples/caching_ex1_1.xml index 38eaf82..2d65d46 100644 --- a/doc/generated/examples/caching_ex1_1.xml +++ b/doc/generated/examples/caching_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q -c diff --git a/doc/generated/examples/caching_ex1_2.xml b/doc/generated/examples/caching_ex1_2.xml index 2f0bcde..1b27272 100644 --- a/doc/generated/examples/caching_ex1_2.xml +++ b/doc/generated/examples/caching_ex1_2.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q -c diff --git a/doc/generated/examples/caching_ex1_4.xml b/doc/generated/examples/caching_ex1_4.xml index 922f1b6..c33dd9b 100644 --- a/doc/generated/examples/caching_ex1_4.xml +++ b/doc/generated/examples/caching_ex1_4.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q -c diff --git a/doc/generated/examples/caching_ex1_5.xml b/doc/generated/examples/caching_ex1_5.xml index 968727f..b784319 100644 --- a/doc/generated/examples/caching_ex1_5.xml +++ b/doc/generated/examples/caching_ex1_5.xml @@ -1,5 +1,4 @@ - -% scons -Q --cache-disable +% scons -Q --cache-disable cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q -c diff --git a/doc/generated/examples/commandline_ARGLIST_1.xml b/doc/generated/examples/commandline_ARGLIST_1.xml index e094bc0..af2d032 100644 --- a/doc/generated/examples/commandline_ARGLIST_1.xml +++ b/doc/generated/examples/commandline_ARGLIST_1.xml @@ -1,5 +1,4 @@ - -% scons -Q define=FOO +% scons -Q define=FOO cc -o prog.o -c -DFOO prog.c % scons -Q define=FOO define=BAR cc -o prog.o -c -DFOO -DBAR prog.c diff --git a/doc/generated/examples/commandline_ARGUMENTS_1.xml b/doc/generated/examples/commandline_ARGUMENTS_1.xml index 6aa4ed2..cd76cfb 100644 --- a/doc/generated/examples/commandline_ARGUMENTS_1.xml +++ b/doc/generated/examples/commandline_ARGUMENTS_1.xml @@ -1,5 +1,4 @@ - -% scons -Q debug=0 +% scons -Q debug=0 cc -o prog.o -c prog.c cc -o prog prog.o % scons -Q debug=0 diff --git a/doc/generated/examples/commandline_AddOption_1.xml b/doc/generated/examples/commandline_AddOption_1.xml index 55df25a..5877f6d 100644 --- a/doc/generated/examples/commandline_AddOption_1.xml +++ b/doc/generated/examples/commandline_AddOption_1.xml @@ -1,4 +1,3 @@ - -% scons -Q -n +% scons -Q -n Install file: "foo.in" as "/usr/bin/foo.in" diff --git a/doc/generated/examples/commandline_AddOption_2.xml b/doc/generated/examples/commandline_AddOption_2.xml index 7d0b978..3000a43 100644 --- a/doc/generated/examples/commandline_AddOption_2.xml +++ b/doc/generated/examples/commandline_AddOption_2.xml @@ -1,4 +1,3 @@ - -% scons -Q -n --prefix=/tmp/install +% scons -Q -n --prefix=/tmp/install Install file: "foo.in" as "/tmp/install/usr/bin/foo.in" diff --git a/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml b/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml index bd51961..be22abf 100644 --- a/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml +++ b/doc/generated/examples/commandline_BUILD_TARGETS_1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q BUILD_TARGETS is ['prog1'] cc -o prog1.o -c prog1.c cc -o prog1 prog1.o diff --git a/doc/generated/examples/commandline_BoolVariable_1.xml b/doc/generated/examples/commandline_BoolVariable_1.xml index e4c1792..481c0a3 100644 --- a/doc/generated/examples/commandline_BoolVariable_1.xml +++ b/doc/generated/examples/commandline_BoolVariable_1.xml @@ -1,4 +1,3 @@ - -% scons -Q RELEASE=yes foo.o +% scons -Q RELEASE=yes foo.o cc -o foo.o -c -DRELEASE_BUILD=True foo.c diff --git a/doc/generated/examples/commandline_BoolVariable_2.xml b/doc/generated/examples/commandline_BoolVariable_2.xml index dc1e068..69f8155 100644 --- a/doc/generated/examples/commandline_BoolVariable_2.xml +++ b/doc/generated/examples/commandline_BoolVariable_2.xml @@ -1,4 +1,3 @@ - -% scons -Q RELEASE=t foo.o +% scons -Q RELEASE=t foo.o cc -o foo.o -c -DRELEASE_BUILD=True foo.c diff --git a/doc/generated/examples/commandline_BoolVariable_3.xml b/doc/generated/examples/commandline_BoolVariable_3.xml index 0750fb5..8d635f7 100644 --- a/doc/generated/examples/commandline_BoolVariable_3.xml +++ b/doc/generated/examples/commandline_BoolVariable_3.xml @@ -1,4 +1,3 @@ - -% scons -Q RELEASE=no foo.o +% scons -Q RELEASE=no foo.o cc -o foo.o -c -DRELEASE_BUILD=False foo.c diff --git a/doc/generated/examples/commandline_BoolVariable_4.xml b/doc/generated/examples/commandline_BoolVariable_4.xml index 84e4639..c576eee 100644 --- a/doc/generated/examples/commandline_BoolVariable_4.xml +++ b/doc/generated/examples/commandline_BoolVariable_4.xml @@ -1,4 +1,3 @@ - -% scons -Q RELEASE=f foo.o +% scons -Q RELEASE=f foo.o cc -o foo.o -c -DRELEASE_BUILD=False foo.c diff --git a/doc/generated/examples/commandline_BoolVariable_5.xml b/doc/generated/examples/commandline_BoolVariable_5.xml index 81f1d4e..2a31296 100644 --- a/doc/generated/examples/commandline_BoolVariable_5.xml +++ b/doc/generated/examples/commandline_BoolVariable_5.xml @@ -1,7 +1,6 @@ - -% scons -Q RELEASE=bad_value foo.o +% scons -Q RELEASE=bad_value foo.o scons: *** Error converting option: RELEASE Invalid value for boolean option: bad_value -File "/home/my/project/SConstruct", line 4, in <module> +File "/home/my/project/SConstruct", line 5, in <module> diff --git a/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml b/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml index 1812f74..ba270b8 100644 --- a/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml +++ b/doc/generated/examples/commandline_COMMAND_LINE_TARGETS_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o foo.o -c foo.c cc -o foo foo.o % scons -Q bar diff --git a/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml b/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml index f92f160..3f9e0fe 100644 --- a/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml +++ b/doc/generated/examples/commandline_DEFAULT_TARGETS_1_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... DEFAULT_TARGETS is ['prog1'] scons: done reading SConscript files. diff --git a/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml b/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml index 01e953b..c51626d 100644 --- a/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml +++ b/doc/generated/examples/commandline_DEFAULT_TARGETS_2_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... DEFAULT_TARGETS is now ['prog1'] DEFAULT_TARGETS is now ['prog1', 'prog2'] diff --git a/doc/generated/examples/commandline_Default1_1.xml b/doc/generated/examples/commandline_Default1_1.xml index 18008d8..8679e25 100644 --- a/doc/generated/examples/commandline_Default1_1.xml +++ b/doc/generated/examples/commandline_Default1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q diff --git a/doc/generated/examples/commandline_Default1_2.xml b/doc/generated/examples/commandline_Default1_2.xml index 0f1a93e..e40c298 100644 --- a/doc/generated/examples/commandline_Default1_2.xml +++ b/doc/generated/examples/commandline_Default1_2.xml @@ -1,5 +1,4 @@ - -% scons -Q . +% scons -Q . cc -o goodbye.o -c goodbye.c cc -o goodbye goodbye.o cc -o hello.o -c hello.c diff --git a/doc/generated/examples/commandline_Default2_1.xml b/doc/generated/examples/commandline_Default2_1.xml index 606ed67..bb4cd0c 100644 --- a/doc/generated/examples/commandline_Default2_1.xml +++ b/doc/generated/examples/commandline_Default2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o prog1.o -c prog1.c cc -o prog1 prog1.o cc -o prog3.o -c prog3.c diff --git a/doc/generated/examples/commandline_Default3_1.xml b/doc/generated/examples/commandline_Default3_1.xml index d18575c..de93fb6 100644 --- a/doc/generated/examples/commandline_Default3_1.xml +++ b/doc/generated/examples/commandline_Default3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o prog1/foo.o -c prog1/foo.c cc -o prog1/main.o -c prog1/main.c cc -o prog1/main prog1/main.o prog1/foo.o diff --git a/doc/generated/examples/commandline_Default4_1.xml b/doc/generated/examples/commandline_Default4_1.xml index 35e0b10..3c16091 100644 --- a/doc/generated/examples/commandline_Default4_1.xml +++ b/doc/generated/examples/commandline_Default4_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q scons: *** No targets specified and no Default() targets found. Stop. Found nothing to build % scons -Q . diff --git a/doc/generated/examples/commandline_EnumVariable_1.xml b/doc/generated/examples/commandline_EnumVariable_1.xml index d658f69..2178dba 100644 --- a/doc/generated/examples/commandline_EnumVariable_1.xml +++ b/doc/generated/examples/commandline_EnumVariable_1.xml @@ -1,5 +1,4 @@ - -% scons -Q COLOR=red foo.o +% scons -Q COLOR=red foo.o cc -o foo.o -c -DCOLOR="red" foo.c % scons -Q COLOR=blue foo.o cc -o foo.o -c -DCOLOR="blue" foo.c diff --git a/doc/generated/examples/commandline_EnumVariable_2.xml b/doc/generated/examples/commandline_EnumVariable_2.xml index a8a18df..65b255b 100644 --- a/doc/generated/examples/commandline_EnumVariable_2.xml +++ b/doc/generated/examples/commandline_EnumVariable_2.xml @@ -1,6 +1,5 @@ - -% scons -Q COLOR=magenta foo.o +% scons -Q COLOR=magenta foo.o scons: *** Invalid value for option COLOR: magenta. Valid values are: ('red', 'green', 'blue') -File "/home/my/project/SConstruct", line 5, in <module> +File "/home/my/project/SConstruct", line 6, in <module> diff --git a/doc/generated/examples/commandline_EnumVariable_ic1_1.xml b/doc/generated/examples/commandline_EnumVariable_ic1_1.xml index db786e5..33f668d 100644 --- a/doc/generated/examples/commandline_EnumVariable_ic1_1.xml +++ b/doc/generated/examples/commandline_EnumVariable_ic1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q COLOR=Red foo.o +% scons -Q COLOR=Red foo.o cc -o foo.o -c -DCOLOR="Red" foo.c % scons -Q COLOR=BLUE foo.o cc -o foo.o -c -DCOLOR="BLUE" foo.c diff --git a/doc/generated/examples/commandline_EnumVariable_ic2_1.xml b/doc/generated/examples/commandline_EnumVariable_ic2_1.xml index 5596608..ef24936 100644 --- a/doc/generated/examples/commandline_EnumVariable_ic2_1.xml +++ b/doc/generated/examples/commandline_EnumVariable_ic2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q COLOR=Red foo.o +% scons -Q COLOR=Red foo.o cc -o foo.o -c -DCOLOR="red" foo.c % scons -Q COLOR=nAvY foo.o cc -o foo.o -c -DCOLOR="blue" foo.c diff --git a/doc/generated/examples/commandline_ListVariable_1.xml b/doc/generated/examples/commandline_ListVariable_1.xml index 6e245a3..f04d1f3 100644 --- a/doc/generated/examples/commandline_ListVariable_1.xml +++ b/doc/generated/examples/commandline_ListVariable_1.xml @@ -1,5 +1,4 @@ - -% scons -Q COLORS=red,blue foo.o +% scons -Q COLORS=red,blue foo.o cc -o foo.o -c -DCOLORS="red blue" foo.c % scons -Q COLORS=blue,green,red foo.o cc -o foo.o -c -DCOLORS="blue green red" foo.c diff --git a/doc/generated/examples/commandline_ListVariable_2.xml b/doc/generated/examples/commandline_ListVariable_2.xml index b964669..50bc815 100644 --- a/doc/generated/examples/commandline_ListVariable_2.xml +++ b/doc/generated/examples/commandline_ListVariable_2.xml @@ -1,5 +1,4 @@ - -% scons -Q COLORS=all foo.o +% scons -Q COLORS=all foo.o cc -o foo.o -c -DCOLORS="red green blue" foo.c % scons -Q COLORS=none foo.o cc -o foo.o -c -DCOLORS="" foo.c diff --git a/doc/generated/examples/commandline_ListVariable_3.xml b/doc/generated/examples/commandline_ListVariable_3.xml index ae13d8b..a5e4b89 100644 --- a/doc/generated/examples/commandline_ListVariable_3.xml +++ b/doc/generated/examples/commandline_ListVariable_3.xml @@ -1,7 +1,6 @@ - -% scons -Q COLORS=magenta foo.o +% scons -Q COLORS=magenta foo.o scons: *** Error converting option: COLORS Invalid value(s) for option: magenta -File "/home/my/project/SConstruct", line 5, in <module> +File "/home/my/project/SConstruct", line 6, in <module> diff --git a/doc/generated/examples/commandline_PackageVariable_1.xml b/doc/generated/examples/commandline_PackageVariable_1.xml index b83fd80..daaa696 100644 --- a/doc/generated/examples/commandline_PackageVariable_1.xml +++ b/doc/generated/examples/commandline_PackageVariable_1.xml @@ -1,5 +1,4 @@ - -% scons -Q foo.o +% scons -Q foo.o cc -o foo.o -c -DPACKAGE="/opt/location" foo.c % scons -Q PACKAGE=/usr/local/location foo.o cc -o foo.o -c -DPACKAGE="/usr/local/location" foo.c diff --git a/doc/generated/examples/commandline_PathVariable_1.xml b/doc/generated/examples/commandline_PathVariable_1.xml index 81693b9..e995a69 100644 --- a/doc/generated/examples/commandline_PathVariable_1.xml +++ b/doc/generated/examples/commandline_PathVariable_1.xml @@ -1,5 +1,4 @@ - -% scons -Q foo.o +% scons -Q foo.o cc -o foo.o -c -DCONFIG_FILE="/etc/my_config" foo.c % scons -Q CONFIG=/usr/local/etc/other_config foo.o scons: `foo.o' is up to date. diff --git a/doc/generated/examples/commandline_PathVariable_2.xml b/doc/generated/examples/commandline_PathVariable_2.xml index 7dde5b1..68a40cb 100644 --- a/doc/generated/examples/commandline_PathVariable_2.xml +++ b/doc/generated/examples/commandline_PathVariable_2.xml @@ -1,6 +1,5 @@ - -% scons -Q CONFIG=/does/not/exist foo.o +% scons -Q CONFIG=/does/not/exist foo.o scons: *** Path for option CONFIG does not exist: /does/not/exist -File "/home/my/project/SConstruct", line 6, in <module> +File "/home/my/project/SConstruct", line 5, in <module> diff --git a/doc/generated/examples/commandline_SCONSFLAGS_1.xml b/doc/generated/examples/commandline_SCONSFLAGS_1.xml index 35e366c..fc54357 100644 --- a/doc/generated/examples/commandline_SCONSFLAGS_1.xml +++ b/doc/generated/examples/commandline_SCONSFLAGS_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/commandline_SetOption_1.xml b/doc/generated/examples/commandline_SetOption_1.xml index bac0cf4..4aedc2e 100644 --- a/doc/generated/examples/commandline_SetOption_1.xml +++ b/doc/generated/examples/commandline_SetOption_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q running with -j 2 scons: `.' is up to date. diff --git a/doc/generated/examples/commandline_SetOption_2.xml b/doc/generated/examples/commandline_SetOption_2.xml index b00e073..54e214f 100644 --- a/doc/generated/examples/commandline_SetOption_2.xml +++ b/doc/generated/examples/commandline_SetOption_2.xml @@ -1,5 +1,4 @@ - -% export NUM_CPU="4" +% export NUM_CPU="4" % scons -Q running with -j 4 scons: `.' is up to date. diff --git a/doc/generated/examples/commandline_SetOption_3.xml b/doc/generated/examples/commandline_SetOption_3.xml index df42ff0..2db0d62 100644 --- a/doc/generated/examples/commandline_SetOption_3.xml +++ b/doc/generated/examples/commandline_SetOption_3.xml @@ -1,5 +1,4 @@ - -% scons -Q -j 7 +% scons -Q -j 7 running with -j 7 scons: `.' is up to date. % export NUM_CPU="4" diff --git a/doc/generated/examples/commandline_UnknownVariables_1.xml b/doc/generated/examples/commandline_UnknownVariables_1.xml index 272a954..ecca75f 100644 --- a/doc/generated/examples/commandline_UnknownVariables_1.xml +++ b/doc/generated/examples/commandline_UnknownVariables_1.xml @@ -1,4 +1,3 @@ - -% scons -Q NOT_KNOWN=foo -Unknown variables: ['NOT_KNOWN'] +% scons -Q NOT_KNOWN=foo +Unknown variables: dict_keys(['NOT_KNOWN']) diff --git a/doc/generated/examples/commandline_Variables1_1.xml b/doc/generated/examples/commandline_Variables1_1.xml index 512ae65..2b6ecf8 100644 --- a/doc/generated/examples/commandline_Variables1_1.xml +++ b/doc/generated/examples/commandline_Variables1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q RELEASE=1 +% scons -Q RELEASE=1 cc -o bar.o -c -DRELEASE_BUILD=1 bar.c cc -o foo.o -c -DRELEASE_BUILD=1 foo.c cc -o foo foo.o bar.o diff --git a/doc/generated/examples/commandline_Variables_Help_1.xml b/doc/generated/examples/commandline_Variables_Help_1.xml index db171eb..9fe588e 100644 --- a/doc/generated/examples/commandline_Variables_Help_1.xml +++ b/doc/generated/examples/commandline_Variables_Help_1.xml @@ -1,5 +1,4 @@ - -% scons -Q -h +% scons -Q -h RELEASE: Set to 1 to build for release default: 0 diff --git a/doc/generated/examples/commandline_Variables_custom_py_1_1.xml b/doc/generated/examples/commandline_Variables_custom_py_1_1.xml index 4ef4d48..bf31267 100644 --- a/doc/generated/examples/commandline_Variables_custom_py_1_1.xml +++ b/doc/generated/examples/commandline_Variables_custom_py_1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o bar.o -c -DRELEASE_BUILD=1 bar.c cc -o foo.o -c -DRELEASE_BUILD=1 foo.c cc -o foo foo.o bar.o diff --git a/doc/generated/examples/commandline_Variables_custom_py_2_1.xml b/doc/generated/examples/commandline_Variables_custom_py_2_1.xml index 5961d0a..fc07260 100644 --- a/doc/generated/examples/commandline_Variables_custom_py_2_1.xml +++ b/doc/generated/examples/commandline_Variables_custom_py_2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o bar.o -c -DRELEASE_BUILD=0 bar.c cc -o foo.o -c -DRELEASE_BUILD=0 foo.c cc -o foo foo.o bar.o diff --git a/doc/generated/examples/depends_AlwaysBuild_1.xml b/doc/generated/examples/depends_AlwaysBuild_1.xml index 86700fe..e8bafae 100644 --- a/doc/generated/examples/depends_AlwaysBuild_1.xml +++ b/doc/generated/examples/depends_AlwaysBuild_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q diff --git a/doc/generated/examples/depends_AlwaysBuild_2.xml b/doc/generated/examples/depends_AlwaysBuild_2.xml index d1bdd6d..501ffa1 100644 --- a/doc/generated/examples/depends_AlwaysBuild_2.xml +++ b/doc/generated/examples/depends_AlwaysBuild_2.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q hello.o diff --git a/doc/generated/examples/depends_Requires_1.xml b/doc/generated/examples/depends_Requires_1.xml index 04bfc35..0a07c01 100644 --- a/doc/generated/examples/depends_Requires_1.xml +++ b/doc/generated/examples/depends_Requires_1.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o version.o -c version.c cc -o hello.o -c hello.c cc -o hello version.o hello.o diff --git a/doc/generated/examples/depends_ex1_1.xml b/doc/generated/examples/depends_ex1_1.xml index 25355c9..1a94afc 100644 --- a/doc/generated/examples/depends_ex1_1.xml +++ b/doc/generated/examples/depends_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q diff --git a/doc/generated/examples/depends_ex1_2.xml b/doc/generated/examples/depends_ex1_2.xml index 09ecc73..0fd2024 100644 --- a/doc/generated/examples/depends_ex1_2.xml +++ b/doc/generated/examples/depends_ex1_2.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q hello diff --git a/doc/generated/examples/depends_ex1_3.xml b/doc/generated/examples/depends_ex1_3.xml index 20062df..6bfba52 100644 --- a/doc/generated/examples/depends_ex1_3.xml +++ b/doc/generated/examples/depends_ex1_3.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c hello.c cc -o hello hello.o % touch hello.c diff --git a/doc/generated/examples/depends_ex1_4.xml b/doc/generated/examples/depends_ex1_4.xml index 31aa5bd..bae5bd7 100644 --- a/doc/generated/examples/depends_ex1_4.xml +++ b/doc/generated/examples/depends_ex1_4.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c hello.c cc -o hello hello.o % [CHANGE THE CONTENTS OF hello.c] diff --git a/doc/generated/examples/depends_ex1_5.xml b/doc/generated/examples/depends_ex1_5.xml index 776bda2..358bf5b 100644 --- a/doc/generated/examples/depends_ex1_5.xml +++ b/doc/generated/examples/depends_ex1_5.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c hello.c cc -o hello hello.o % [CHANGE A COMMENT IN hello.c] diff --git a/doc/generated/examples/depends_ex1_6.xml b/doc/generated/examples/depends_ex1_6.xml index 7493627..8461234 100644 --- a/doc/generated/examples/depends_ex1_6.xml +++ b/doc/generated/examples/depends_ex1_6.xml @@ -1,5 +1,4 @@ - -% scons -Q --implicit-cache hello +% scons -Q --implicit-cache hello cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q hello diff --git a/doc/generated/examples/depends_ex1_7.xml b/doc/generated/examples/depends_ex1_7.xml index 22b56d3..ea9088a 100644 --- a/doc/generated/examples/depends_ex1_7.xml +++ b/doc/generated/examples/depends_ex1_7.xml @@ -1,5 +1,4 @@ - -% scons -Q --implicit-deps-changed hello +% scons -Q --implicit-deps-changed hello cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q hello diff --git a/doc/generated/examples/depends_ex1_8.xml b/doc/generated/examples/depends_ex1_8.xml index d60db97..cc4ee6c 100644 --- a/doc/generated/examples/depends_ex1_8.xml +++ b/doc/generated/examples/depends_ex1_8.xml @@ -1,5 +1,4 @@ - -% scons -Q --implicit-deps-unchanged hello +% scons -Q --implicit-deps-unchanged hello cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q hello diff --git a/doc/generated/examples/depends_ex5_1.xml b/doc/generated/examples/depends_ex5_1.xml index e81cb0c..37985df 100644 --- a/doc/generated/examples/depends_ex5_1.xml +++ b/doc/generated/examples/depends_ex5_1.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c -Iinclude -I/home/project/inc hello.c cc -o hello hello.o diff --git a/doc/generated/examples/depends_ex5_2.xml b/doc/generated/examples/depends_ex5_2.xml index ea78590..460d135 100644 --- a/doc/generated/examples/depends_ex5_2.xml +++ b/doc/generated/examples/depends_ex5_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q hello.exe +C:\>scons -Q hello.exe cl /Fohello.obj /c hello.c /nologo /Iinclude /I\home\project\inc link /nologo /OUT:hello.exe hello.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/depends_ignore_explicit_1.xml b/doc/generated/examples/depends_ignore_explicit_1.xml index a45a852..79ebca2 100644 --- a/doc/generated/examples/depends_ignore_explicit_1.xml +++ b/doc/generated/examples/depends_ignore_explicit_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q scons: `.' is up to date. % scons -Q hello cc -o hello.o -c hello.c diff --git a/doc/generated/examples/depends_include_1.xml b/doc/generated/examples/depends_include_1.xml index e22bd03..987fead 100644 --- a/doc/generated/examples/depends_include_1.xml +++ b/doc/generated/examples/depends_include_1.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c -I. hello.c cc -o hello hello.o % scons -Q hello diff --git a/doc/generated/examples/depends_macroinc_1.xml b/doc/generated/examples/depends_macroinc_1.xml index 95d4e0b..d15f4ef 100644 --- a/doc/generated/examples/depends_macroinc_1.xml +++ b/doc/generated/examples/depends_macroinc_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c -I. hello.c cc -o hello hello.o % [CHANGE CONTENTS OF foo.h] diff --git a/doc/generated/examples/depends_match_1.xml b/doc/generated/examples/depends_match_1.xml index 7dc3831..cde65ca 100644 --- a/doc/generated/examples/depends_match_1.xml +++ b/doc/generated/examples/depends_match_1.xml @@ -1,5 +1,4 @@ - -% scons -Q hello.o +% scons -Q hello.o cc -o hello.o -c hello.c % touch -t 198901010000 hello.c % scons -Q hello.o diff --git a/doc/generated/examples/depends_mixing_1.xml b/doc/generated/examples/depends_mixing_1.xml index 258dc90..30d2527 100644 --- a/doc/generated/examples/depends_mixing_1.xml +++ b/doc/generated/examples/depends_mixing_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o program1.o -c -I. program1.c cc -o prog-MD5 program1.o cc -o program2.o -c -I. program2.c diff --git a/doc/generated/examples/depends_newer_1.xml b/doc/generated/examples/depends_newer_1.xml index 28cb427..b09d0d6 100644 --- a/doc/generated/examples/depends_newer_1.xml +++ b/doc/generated/examples/depends_newer_1.xml @@ -1,5 +1,4 @@ - -% scons -Q hello.o +% scons -Q hello.o cc -o hello.o -c hello.c % touch hello.c % scons -Q hello.o diff --git a/doc/generated/examples/depends_no-Requires_1.xml b/doc/generated/examples/depends_no-Requires_1.xml index 8e2729f..8be3285 100644 --- a/doc/generated/examples/depends_no-Requires_1.xml +++ b/doc/generated/examples/depends_no-Requires_1.xml @@ -1,5 +1,4 @@ - -% scons -Q hello +% scons -Q hello cc -o hello.o -c hello.c cc -o version.o -c version.c cc -o hello hello.o version.o diff --git a/doc/generated/examples/depends_parsedep_1.xml b/doc/generated/examples/depends_parsedep_1.xml index 910930b1..e83eccf 100644 --- a/doc/generated/examples/depends_parsedep_1.xml +++ b/doc/generated/examples/depends_parsedep_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c -MD -MF hello.d -I. hello.c cc -o hello hello.o % [CHANGE CONTENTS OF foo.h] diff --git a/doc/generated/examples/environments_Append-nonexistent_1.xml b/doc/generated/examples/environments_Append-nonexistent_1.xml index bb15965..43b6834 100644 --- a/doc/generated/examples/environments_Append-nonexistent_1.xml +++ b/doc/generated/examples/environments_Append-nonexistent_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q NEW_VARIABLE = added scons: `.' is up to date. diff --git a/doc/generated/examples/environments_Prepend-nonexistent_1.xml b/doc/generated/examples/environments_Prepend-nonexistent_1.xml index bb15965..43b6834 100644 --- a/doc/generated/examples/environments_Prepend-nonexistent_1.xml +++ b/doc/generated/examples/environments_Prepend-nonexistent_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q NEW_VARIABLE = added scons: `.' is up to date. diff --git a/doc/generated/examples/environments_Replace-nonexistent_1.xml b/doc/generated/examples/environments_Replace-nonexistent_1.xml index c4480b5..2aba4c8 100644 --- a/doc/generated/examples/environments_Replace-nonexistent_1.xml +++ b/doc/generated/examples/environments_Replace-nonexistent_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q NEW_VARIABLE = xyzzy scons: `.' is up to date. diff --git a/doc/generated/examples/environments_Replace1_1.xml b/doc/generated/examples/environments_Replace1_1.xml index 54f4976..6fedc45 100644 --- a/doc/generated/examples/environments_Replace1_1.xml +++ b/doc/generated/examples/environments_Replace1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o foo.o -c -DDEFINE2 foo.c cc -o foo foo.o diff --git a/doc/generated/examples/environments_Replace2_1.xml b/doc/generated/examples/environments_Replace2_1.xml index 9ad257b..61027c8 100644 --- a/doc/generated/examples/environments_Replace2_1.xml +++ b/doc/generated/examples/environments_Replace2_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... CCFLAGS = -DDEFINE1 CCFLAGS = -DDEFINE2 diff --git a/doc/generated/examples/environments_ex1_1.xml b/doc/generated/examples/environments_ex1_1.xml index 84d22b8..1c4da07 100644 --- a/doc/generated/examples/environments_ex1_1.xml +++ b/doc/generated/examples/environments_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q gcc -o foo.o -c -O2 foo.c gcc -o foo foo.o diff --git a/doc/generated/examples/environments_ex2_1.xml b/doc/generated/examples/environments_ex2_1.xml index eb86c9e..acab07b 100644 --- a/doc/generated/examples/environments_ex2_1.xml +++ b/doc/generated/examples/environments_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o bar.o -c -g bar.c cc -o bar bar.o cc -o foo.o -c -O2 foo.c diff --git a/doc/generated/examples/environments_ex3_1.xml b/doc/generated/examples/environments_ex3_1.xml index 3262302..1c7bce9 100644 --- a/doc/generated/examples/environments_ex3_1.xml +++ b/doc/generated/examples/environments_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q scons: *** Two environments with different actions were specified for the same target: foo.o File "/home/my/project/SConstruct", line 6, in <module> diff --git a/doc/generated/examples/environments_ex4_1.xml b/doc/generated/examples/environments_ex4_1.xml index 286f46f..4eda402 100644 --- a/doc/generated/examples/environments_ex4_1.xml +++ b/doc/generated/examples/environments_ex4_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o foo-dbg.o -c -g foo.c cc -o foo-dbg foo-dbg.o cc -o foo-opt.o -c -O2 foo.c diff --git a/doc/generated/examples/environments_ex5_1.xml b/doc/generated/examples/environments_ex5_1.xml index d6f0094..7316a6c 100644 --- a/doc/generated/examples/environments_ex5_1.xml +++ b/doc/generated/examples/environments_ex5_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q gcc -o foo.o -c foo.c gcc -o foo foo.o gcc -o foo-dbg.o -c -g foo.c diff --git a/doc/generated/examples/environments_ex6_1.xml b/doc/generated/examples/environments_ex6_1.xml index af8667f..f6aa4b6 100644 --- a/doc/generated/examples/environments_ex6_1.xml +++ b/doc/generated/examples/environments_ex6_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q CC is: cc scons: `.' is up to date. diff --git a/doc/generated/examples/environments_ex6b_1.xml b/doc/generated/examples/environments_ex6b_1.xml index 47a499a..0da8d90 100644 --- a/doc/generated/examples/environments_ex6b_1.xml +++ b/doc/generated/examples/environments_ex6b_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q key = OBJSUFFIX, value = .o key = LIBSUFFIX, value = .a key = PROGSUFFIX, value = diff --git a/doc/generated/examples/environments_ex6b_2.xml b/doc/generated/examples/environments_ex6b_2.xml index 73a6d19..d0f20e9 100644 --- a/doc/generated/examples/environments_ex6b_2.xml +++ b/doc/generated/examples/environments_ex6b_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q key = OBJSUFFIX, value = .obj key = LIBSUFFIX, value = .lib key = PROGSUFFIX, value = .exe diff --git a/doc/generated/examples/environments_ex8_1.xml b/doc/generated/examples/environments_ex8_1.xml index 68ebac4..fe3b464 100644 --- a/doc/generated/examples/environments_ex8_1.xml +++ b/doc/generated/examples/environments_ex8_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o foo.o -c -DMY_VALUE -DLAST foo.c cc -o foo foo.o diff --git a/doc/generated/examples/environments_ex9_1.xml b/doc/generated/examples/environments_ex9_1.xml index 3e31c3f..4d7bfd8 100644 --- a/doc/generated/examples/environments_ex9_1.xml +++ b/doc/generated/examples/environments_ex9_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o foo.o -c -DFIRST -DMY_VALUE foo.c cc -o foo foo.o diff --git a/doc/generated/examples/environments_missing1_1.xml b/doc/generated/examples/environments_missing1_1.xml index edf136f..56b0ff5 100644 --- a/doc/generated/examples/environments_missing1_1.xml +++ b/doc/generated/examples/environments_missing1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q value is: -><- scons: `.' is up to date. diff --git a/doc/generated/examples/environments_missing2_1.xml b/doc/generated/examples/environments_missing2_1.xml index ffb308c..5a11ede 100644 --- a/doc/generated/examples/environments_missing2_1.xml +++ b/doc/generated/examples/environments_missing2_1.xml @@ -1,6 +1,5 @@ - -% scons -Q +% scons -Q -scons: *** NameError `MISSING' trying to evaluate `$MISSING' +scons: *** NameError `name 'MISSING' is not defined' trying to evaluate `$MISSING' File "/home/my/project/SConstruct", line 3, in <module> diff --git a/doc/generated/examples/environments_missing3_1.xml b/doc/generated/examples/environments_missing3_1.xml index edf136f..56b0ff5 100644 --- a/doc/generated/examples/environments_missing3_1.xml +++ b/doc/generated/examples/environments_missing3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q value is: -><- scons: `.' is up to date. diff --git a/doc/generated/examples/factories_Chmod_1.xml b/doc/generated/examples/factories_Chmod_1.xml index a324ed4..04e543c 100644 --- a/doc/generated/examples/factories_Chmod_1.xml +++ b/doc/generated/examples/factories_Chmod_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Copy("file.out", "file.in") Chmod("file.out", 0755) diff --git a/doc/generated/examples/factories_Copy1_1.xml b/doc/generated/examples/factories_Copy1_1.xml index 852412f..02941a2 100644 --- a/doc/generated/examples/factories_Copy1_1.xml +++ b/doc/generated/examples/factories_Copy1_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q Copy("file.out", "file.in") diff --git a/doc/generated/examples/factories_Copy2_1.xml b/doc/generated/examples/factories_Copy2_1.xml index 852412f..02941a2 100644 --- a/doc/generated/examples/factories_Copy2_1.xml +++ b/doc/generated/examples/factories_Copy2_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q Copy("file.out", "file.in") diff --git a/doc/generated/examples/factories_Copy3_1.xml b/doc/generated/examples/factories_Copy3_1.xml index bcb41ff..224ec79 100644 --- a/doc/generated/examples/factories_Copy3_1.xml +++ b/doc/generated/examples/factories_Copy3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Copy("tempfile", "file.in") modify tempfile Copy("file.out", "tempfile") diff --git a/doc/generated/examples/factories_Delete1_1.xml b/doc/generated/examples/factories_Delete1_1.xml index e9a287e..22b5070 100644 --- a/doc/generated/examples/factories_Delete1_1.xml +++ b/doc/generated/examples/factories_Delete1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Delete("tempfile") Copy("tempfile", "file.in") modify tempfile diff --git a/doc/generated/examples/factories_Delete2_1.xml b/doc/generated/examples/factories_Delete2_1.xml index 2be3c3a..109ed2c 100644 --- a/doc/generated/examples/factories_Delete2_1.xml +++ b/doc/generated/examples/factories_Delete2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Delete("file.out") Copy("file.out", "file.in") diff --git a/doc/generated/examples/factories_Execute_1.xml b/doc/generated/examples/factories_Execute_1.xml index a7ae0c7..0481396 100644 --- a/doc/generated/examples/factories_Execute_1.xml +++ b/doc/generated/examples/factories_Execute_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... Mkdir("/tmp/my_temp_directory") scons: done reading SConscript files. diff --git a/doc/generated/examples/factories_Mkdir_1.xml b/doc/generated/examples/factories_Mkdir_1.xml index ea3d79d..37c601d 100644 --- a/doc/generated/examples/factories_Mkdir_1.xml +++ b/doc/generated/examples/factories_Mkdir_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Delete("tempdir") Mkdir("tempdir") Copy("tempdir/file.in", "file.in") diff --git a/doc/generated/examples/factories_Move_1.xml b/doc/generated/examples/factories_Move_1.xml index a5e4ccd..a49ecef 100644 --- a/doc/generated/examples/factories_Move_1.xml +++ b/doc/generated/examples/factories_Move_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Copy("tempfile", "file.in") modify tempfile Move("file.out", "tempfile") diff --git a/doc/generated/examples/factories_Touch_1.xml b/doc/generated/examples/factories_Touch_1.xml index 7417fa4..dbc256a 100644 --- a/doc/generated/examples/factories_Touch_1.xml +++ b/doc/generated/examples/factories_Touch_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Copy("file.out", "file.in") Touch("file.out") diff --git a/doc/generated/examples/fileremoval_clean-ex1_1.xml b/doc/generated/examples/fileremoval_clean-ex1_1.xml index c76a7e5..0d79060 100644 --- a/doc/generated/examples/fileremoval_clean-ex1_1.xml +++ b/doc/generated/examples/fileremoval_clean-ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q build -o foo.out foo.in % scons -Q -c Removed foo.out diff --git a/doc/generated/examples/fileremoval_noclean-ex1_1.xml b/doc/generated/examples/fileremoval_noclean-ex1_1.xml index 45bd878..bf5e42f 100644 --- a/doc/generated/examples/fileremoval_noclean-ex1_1.xml +++ b/doc/generated/examples/fileremoval_noclean-ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/fileremoval_precious-ex1_1.xml b/doc/generated/examples/fileremoval_precious-ex1_1.xml index 36e5a25..232703f 100644 --- a/doc/generated/examples/fileremoval_precious-ex1_1.xml +++ b/doc/generated/examples/fileremoval_precious-ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/hierarchy_Return_1.xml b/doc/generated/examples/hierarchy_Return_1.xml index e5ab7f7..417780f 100644 --- a/doc/generated/examples/hierarchy_Return_1.xml +++ b/doc/generated/examples/hierarchy_Return_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o bar/bar.o -c bar/bar.c cc -o foo/foo.o -c foo/foo.c ar rc libprog.a foo/foo.o bar/bar.o diff --git a/doc/generated/examples/hierarchy_ex1_1.xml b/doc/generated/examples/hierarchy_ex1_1.xml index bb5cc7b..c043c4b 100644 --- a/doc/generated/examples/hierarchy_ex1_1.xml +++ b/doc/generated/examples/hierarchy_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o prog1/foo1.o -c prog1/foo1.c cc -o prog1/foo2.o -c prog1/foo2.c cc -o prog1/main.o -c prog1/main.c diff --git a/doc/generated/examples/hierarchy_ex2_1.xml b/doc/generated/examples/hierarchy_ex2_1.xml index 800a921..c6c7401 100644 --- a/doc/generated/examples/hierarchy_ex2_1.xml +++ b/doc/generated/examples/hierarchy_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o lib/foo1.o -c lib/foo1.c cc -o src/prog/foo2.o -c src/prog/foo2.c cc -o src/prog/main.o -c src/prog/main.c diff --git a/doc/generated/examples/hierarchy_ex3_1.xml b/doc/generated/examples/hierarchy_ex3_1.xml index 473c9f4..8c13ee3 100644 --- a/doc/generated/examples/hierarchy_ex3_1.xml +++ b/doc/generated/examples/hierarchy_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o src/prog/foo2.o -c src/prog/foo2.c cc -o src/prog/main.o -c src/prog/main.c cc -o /usr/joe/lib/foo1.o -c /usr/joe/lib/foo1.c diff --git a/doc/generated/examples/install_ex1_1.xml b/doc/generated/examples/install_ex1_1.xml index 776f7e8..30613e2 100644 --- a/doc/generated/examples/install_ex1_1.xml +++ b/doc/generated/examples/install_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q /usr/bin diff --git a/doc/generated/examples/install_ex2_1.xml b/doc/generated/examples/install_ex2_1.xml index 98de9c4..2354878 100644 --- a/doc/generated/examples/install_ex2_1.xml +++ b/doc/generated/examples/install_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o % scons -Q install diff --git a/doc/generated/examples/install_ex3_1.xml b/doc/generated/examples/install_ex3_1.xml index e306111..0396853 100644 --- a/doc/generated/examples/install_ex3_1.xml +++ b/doc/generated/examples/install_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q install +% scons -Q install cc -o goodbye.o -c goodbye.c cc -o goodbye goodbye.o Install file: "goodbye" as "/usr/bin/goodbye" diff --git a/doc/generated/examples/install_ex4_1.xml b/doc/generated/examples/install_ex4_1.xml index 36cd90c..1bbbf65 100644 --- a/doc/generated/examples/install_ex4_1.xml +++ b/doc/generated/examples/install_ex4_1.xml @@ -1,5 +1,4 @@ - -% scons -Q install +% scons -Q install cc -o hello.o -c hello.c cc -o hello hello.o Install file: "hello" as "/usr/bin/hello-new" diff --git a/doc/generated/examples/install_ex5_1.xml b/doc/generated/examples/install_ex5_1.xml index 89f7c56..22c6b01 100644 --- a/doc/generated/examples/install_ex5_1.xml +++ b/doc/generated/examples/install_ex5_1.xml @@ -1,5 +1,4 @@ - -% scons -Q install +% scons -Q install cc -o goodbye.o -c goodbye.c cc -o goodbye goodbye.o Install file: "goodbye" as "/usr/bin/goodbye-new" diff --git a/doc/generated/examples/java_JAVACLASSDIR_1.xml b/doc/generated/examples/java_JAVACLASSDIR_1.xml index 5e0709a..75e5f95 100644 --- a/doc/generated/examples/java_JAVACLASSDIR_1.xml +++ b/doc/generated/examples/java_JAVACLASSDIR_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java src/pkg/sub/Example3.java javah -d native -classpath classes pkg.sub.Example1 pkg.sub.Example2 pkg.sub.Example3 diff --git a/doc/generated/examples/java_RMIC_1.xml b/doc/generated/examples/java_RMIC_1.xml index 4db895e..16297dc 100644 --- a/doc/generated/examples/java_RMIC_1.xml +++ b/doc/generated/examples/java_RMIC_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java rmic -d outdir -classpath classes pkg.sub.Example1 pkg.sub.Example2 diff --git a/doc/generated/examples/java_jar1_1.xml b/doc/generated/examples/java_jar1_1.xml index de93227..a88c00a 100644 --- a/doc/generated/examples/java_jar1_1.xml +++ b/doc/generated/examples/java_jar1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java jar cf test.jar classes diff --git a/doc/generated/examples/java_jar2_1.xml b/doc/generated/examples/java_jar2_1.xml index 9e942e2..c696fbd 100644 --- a/doc/generated/examples/java_jar2_1.xml +++ b/doc/generated/examples/java_jar2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath prog1 prog1/Example1.java prog1/Example2.java javac -d classes -sourcepath prog2 prog2/Example3.java prog2/Example4.java jar cf prog1.jar -C classes Example1.class -C classes Example2.class diff --git a/doc/generated/examples/java_java-classes_1.xml b/doc/generated/examples/java_java-classes_1.xml index 6f02f5f..ce3c9ef 100644 --- a/doc/generated/examples/java_java-classes_1.xml +++ b/doc/generated/examples/java_java-classes_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java % scons -Q classes scons: `classes' is up to date. diff --git a/doc/generated/examples/java_java-classes_2.xml b/doc/generated/examples/java_java-classes_2.xml index 31f6028..b773402 100644 --- a/doc/generated/examples/java_java-classes_2.xml +++ b/doc/generated/examples/java_java-classes_2.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java % scons -Q -c classes Removed classes/Example1.class diff --git a/doc/generated/examples/java_java_1.xml b/doc/generated/examples/java_java_1.xml index 551a5d4..13078eb 100644 --- a/doc/generated/examples/java_java_1.xml +++ b/doc/generated/examples/java_java_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src src/Example1.java src/Example2.java src/Example3.java diff --git a/doc/generated/examples/java_javah_1.xml b/doc/generated/examples/java_javah_1.xml index 5e0709a..75e5f95 100644 --- a/doc/generated/examples/java_javah_1.xml +++ b/doc/generated/examples/java_javah_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java src/pkg/sub/Example3.java javah -d native -classpath classes pkg.sub.Example1 pkg.sub.Example2 pkg.sub.Example3 diff --git a/doc/generated/examples/java_javah_file_1.xml b/doc/generated/examples/java_javah_file_1.xml index 163a53d..018a964 100644 --- a/doc/generated/examples/java_javah_file_1.xml +++ b/doc/generated/examples/java_javah_file_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q javac -d classes -sourcepath src/pkg/sub src/pkg/sub/Example1.java src/pkg/sub/Example2.java src/pkg/sub/Example3.java javah -o native.h -classpath classes pkg.sub.Example1 pkg.sub.Example2 pkg.sub.Example3 diff --git a/doc/generated/examples/lesssimple_ex2_1.xml b/doc/generated/examples/lesssimple_ex2_1.xml index 6093f0c..d643101 100644 --- a/doc/generated/examples/lesssimple_ex2_1.xml +++ b/doc/generated/examples/lesssimple_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o file1.o -c file1.c cc -o file2.o -c file2.c cc -o prog.o -c prog.c diff --git a/doc/generated/examples/lesssimple_ex3_1.xml b/doc/generated/examples/lesssimple_ex3_1.xml index b3ac2f0..5ff2046 100644 --- a/doc/generated/examples/lesssimple_ex3_1.xml +++ b/doc/generated/examples/lesssimple_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o file1.o -c file1.c cc -o file2.o -c file2.c cc -o prog.o -c prog.c diff --git a/doc/generated/examples/lesssimple_ex3_2.xml b/doc/generated/examples/lesssimple_ex3_2.xml index 835f048..753bf7f 100644 --- a/doc/generated/examples/lesssimple_ex3_2.xml +++ b/doc/generated/examples/lesssimple_ex3_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fofile1.obj /c file1.c /nologo cl /Fofile2.obj /c file2.c /nologo cl /Foprog.obj /c prog.c /nologo diff --git a/doc/generated/examples/lesssimple_ex4_1.xml b/doc/generated/examples/lesssimple_ex4_1.xml index 87af41d..26d6167 100644 --- a/doc/generated/examples/lesssimple_ex4_1.xml +++ b/doc/generated/examples/lesssimple_ex4_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o bar1.o -c bar1.c cc -o bar2.o -c bar2.c cc -o bar bar1.o bar2.o diff --git a/doc/generated/examples/lesssimple_ex5_1.xml b/doc/generated/examples/lesssimple_ex5_1.xml index 0043e11..ea9e0e5 100644 --- a/doc/generated/examples/lesssimple_ex5_1.xml +++ b/doc/generated/examples/lesssimple_ex5_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o bar1.o -c bar1.c cc -o bar2.o -c bar2.c cc -o common1.o -c common1.c diff --git a/doc/generated/examples/lesssimple_target_1.xml b/doc/generated/examples/lesssimple_target_1.xml index a958acb..6280522 100644 --- a/doc/generated/examples/lesssimple_target_1.xml +++ b/doc/generated/examples/lesssimple_target_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o new_hello hello.o diff --git a/doc/generated/examples/lesssimple_target_2.xml b/doc/generated/examples/lesssimple_target_2.xml index ef7b241..a438d35 100644 --- a/doc/generated/examples/lesssimple_target_2.xml +++ b/doc/generated/examples/lesssimple_target_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fohello.obj /c hello.c /nologo link /nologo /OUT:new_hello.exe hello.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/libraries_SharedLibrary_1.xml b/doc/generated/examples/libraries_SharedLibrary_1.xml index 2300891..ed11d19 100644 --- a/doc/generated/examples/libraries_SharedLibrary_1.xml +++ b/doc/generated/examples/libraries_SharedLibrary_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o f1.os -c f1.c cc -o f2.os -c f2.c cc -o f3.os -c f3.c diff --git a/doc/generated/examples/libraries_SharedLibrary_2.xml b/doc/generated/examples/libraries_SharedLibrary_2.xml index b6b484d..7b752d7 100644 --- a/doc/generated/examples/libraries_SharedLibrary_2.xml +++ b/doc/generated/examples/libraries_SharedLibrary_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fof1.obj /c f1.c /nologo cl /Fof2.obj /c f2.c /nologo cl /Fof3.obj /c f3.c /nologo diff --git a/doc/generated/examples/libraries_ex1_1.xml b/doc/generated/examples/libraries_ex1_1.xml index bfd69b4..4a14b5b 100644 --- a/doc/generated/examples/libraries_ex1_1.xml +++ b/doc/generated/examples/libraries_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/libraries_ex1_2.xml b/doc/generated/examples/libraries_ex1_2.xml index 912e7ad..75c4186 100644 --- a/doc/generated/examples/libraries_ex1_2.xml +++ b/doc/generated/examples/libraries_ex1_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fof1.obj /c f1.c /nologo cl /Fof2.obj /c f2.c /nologo cl /Fof3.obj /c f3.c /nologo diff --git a/doc/generated/examples/libraries_ex2_1.xml b/doc/generated/examples/libraries_ex2_1.xml index c43f7e9..c59edf4 100644 --- a/doc/generated/examples/libraries_ex2_1.xml +++ b/doc/generated/examples/libraries_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o f1.o -c f1.c cc -o f2.o -c f2.c cc -o f3.o -c f3.c diff --git a/doc/generated/examples/libraries_ex2_2.xml b/doc/generated/examples/libraries_ex2_2.xml index 84b4d75..f590dc8 100644 --- a/doc/generated/examples/libraries_ex2_2.xml +++ b/doc/generated/examples/libraries_ex2_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fof1.obj /c f1.c /nologo cl /Fof2.obj /c f2.c /nologo cl /Fof3.obj /c f3.c /nologo diff --git a/doc/generated/examples/libraries_ex3_1.xml b/doc/generated/examples/libraries_ex3_1.xml index 9dd6ca9..f5fd4c8 100644 --- a/doc/generated/examples/libraries_ex3_1.xml +++ b/doc/generated/examples/libraries_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o prog.o -c prog.c cc -o prog prog.o -L/usr/lib -L/usr/local/lib -lm diff --git a/doc/generated/examples/libraries_ex3_2.xml b/doc/generated/examples/libraries_ex3_2.xml index e5ec4ce..433f7fb 100644 --- a/doc/generated/examples/libraries_ex3_2.xml +++ b/doc/generated/examples/libraries_ex3_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Foprog.obj /c prog.c /nologo link /nologo /OUT:prog.exe /LIBPATH:\usr\lib /LIBPATH:\usr\local\lib m.lib prog.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/libraries_objects_1.xml b/doc/generated/examples/libraries_objects_1.xml index 5d732da..db5d88c 100644 --- a/doc/generated/examples/libraries_objects_1.xml +++ b/doc/generated/examples/libraries_objects_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o f1.o -c f1.c cc -o f3.o -c f3.c ar rc libfoo.a f1.o f2.o f3.o f4.o diff --git a/doc/generated/examples/mergeflags_MergeFlags1_1.xml b/doc/generated/examples/mergeflags_MergeFlags1_1.xml index 8f18fd8..fafefd4 100644 --- a/doc/generated/examples/mergeflags_MergeFlags1_1.xml +++ b/doc/generated/examples/mergeflags_MergeFlags1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q ['-option', '-O1', '-whatever', '-O3'] scons: `.' is up to date. diff --git a/doc/generated/examples/mergeflags_MergeFlags2_1.xml b/doc/generated/examples/mergeflags_MergeFlags2_1.xml index 8cae827..017158a 100644 --- a/doc/generated/examples/mergeflags_MergeFlags2_1.xml +++ b/doc/generated/examples/mergeflags_MergeFlags2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q ['/include', '/usr/local/include', '/usr/include', '/usr/opt/include'] scons: `.' is up to date. diff --git a/doc/generated/examples/mergeflags_MergeFlags3_1.xml b/doc/generated/examples/mergeflags_MergeFlags3_1.xml index d4f23d4..2173cf3 100644 --- a/doc/generated/examples/mergeflags_MergeFlags3_1.xml +++ b/doc/generated/examples/mergeflags_MergeFlags3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q ['-option', '-O1', '-whatever', '-O3'] ['/include', '/usr/local/include', '/usr/include', '/usr/opt/include'] scons: `.' is up to date. diff --git a/doc/generated/examples/misc_Exit_1.xml b/doc/generated/examples/misc_Exit_1.xml index 6af378f..5a5e411 100644 --- a/doc/generated/examples/misc_Exit_1.xml +++ b/doc/generated/examples/misc_Exit_1.xml @@ -1,5 +1,4 @@ - -% scons -Q FUTURE=1 +% scons -Q FUTURE=1 The FUTURE option is not supported yet! % scons -Q cc -o hello.o -c hello.c diff --git a/doc/generated/examples/misc_FindFile1a_1.xml b/doc/generated/examples/misc_FindFile1a_1.xml index eca0328..efa6b7c 100644 --- a/doc/generated/examples/misc_FindFile1a_1.xml +++ b/doc/generated/examples/misc_FindFile1a_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q None <class 'SCons.Node.FS.File'> exists scons: `.' is up to date. diff --git a/doc/generated/examples/misc_FindFile1b_1.xml b/doc/generated/examples/misc_FindFile1b_1.xml index 4b194ce..2ab6acb 100644 --- a/doc/generated/examples/misc_FindFile1b_1.xml +++ b/doc/generated/examples/misc_FindFile1b_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q nonesuch.h : None config.h : config.h private.h : src/include/private.h diff --git a/doc/generated/examples/misc_FindFile1d_1.xml b/doc/generated/examples/misc_FindFile1d_1.xml index 5ab499f..3312c42 100644 --- a/doc/generated/examples/misc_FindFile1d_1.xml +++ b/doc/generated/examples/misc_FindFile1d_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q sub1/multiple sub2/multiple sub3/multiple diff --git a/doc/generated/examples/misc_FindFile2_1.xml b/doc/generated/examples/misc_FindFile2_1.xml index 149c5d5..7302968 100644 --- a/doc/generated/examples/misc_FindFile2_1.xml +++ b/doc/generated/examples/misc_FindFile2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q leaf derived cat > derived leaf diff --git a/doc/generated/examples/misc_FindFile2_2.xml b/doc/generated/examples/misc_FindFile2_2.xml index 149c5d5..7302968 100644 --- a/doc/generated/examples/misc_FindFile2_2.xml +++ b/doc/generated/examples/misc_FindFile2_2.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q leaf derived cat > derived leaf diff --git a/doc/generated/examples/misc_FindFile3_1.xml b/doc/generated/examples/misc_FindFile3_1.xml index 2c09fed..69cfacf 100644 --- a/doc/generated/examples/misc_FindFile3_1.xml +++ b/doc/generated/examples/misc_FindFile3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q build/leaf scons: `.' is up to date. diff --git a/doc/generated/examples/misc_Flatten1_1.xml b/doc/generated/examples/misc_Flatten1_1.xml index 54720bb..db574ed 100644 --- a/doc/generated/examples/misc_Flatten1_1.xml +++ b/doc/generated/examples/misc_Flatten1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o prog1.o -c prog1.c cc -o prog2.o -c -DFOO prog2.c cc -o prog1 prog1.o prog2.o diff --git a/doc/generated/examples/misc_Flatten2_1.xml b/doc/generated/examples/misc_Flatten2_1.xml index 66161ec..06b99c3 100644 --- a/doc/generated/examples/misc_Flatten2_1.xml +++ b/doc/generated/examples/misc_Flatten2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q AttributeError: 'NodeList' object has no attribute 'abspath': File "/home/my/project/SConstruct", line 8: print(object_file.abspath) diff --git a/doc/generated/examples/nodes_GetBuildPath_1.xml b/doc/generated/examples/nodes_GetBuildPath_1.xml index 376f65e..50543ab 100644 --- a/doc/generated/examples/nodes_GetBuildPath_1.xml +++ b/doc/generated/examples/nodes_GetBuildPath_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q ['foo.c', 'sub/dir/value'] scons: `.' is up to date. diff --git a/doc/generated/examples/nodes_ex1_1.xml b/doc/generated/examples/nodes_ex1_1.xml index e7eb8c4..f05281f 100644 --- a/doc/generated/examples/nodes_ex1_1.xml +++ b/doc/generated/examples/nodes_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o goodbye.o -c -DGOODBYE goodbye.c cc -o hello.o -c -DHELLO hello.c cc -o hello hello.o goodbye.o diff --git a/doc/generated/examples/nodes_ex1_2.xml b/doc/generated/examples/nodes_ex1_2.xml index a1ed1fb..3648775 100644 --- a/doc/generated/examples/nodes_ex1_2.xml +++ b/doc/generated/examples/nodes_ex1_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fogoodbye.obj /c goodbye.c -DGOODBYE cl /Fohello.obj /c hello.c -DHELLO link /nologo /OUT:hello.exe hello.obj goodbye.obj diff --git a/doc/generated/examples/nodes_exists_1.xml b/doc/generated/examples/nodes_exists_1.xml index a290b1c..f9abc43 100644 --- a/doc/generated/examples/nodes_exists_1.xml +++ b/doc/generated/examples/nodes_exists_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q hello does not exist! cc -o hello.o -c hello.c cc -o hello hello.o diff --git a/doc/generated/examples/nodes_print_1.xml b/doc/generated/examples/nodes_print_1.xml index 11a3f45..0d07e97 100644 --- a/doc/generated/examples/nodes_print_1.xml +++ b/doc/generated/examples/nodes_print_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q The object file is: hello.o The program file is: hello cc -o hello.o -c hello.c diff --git a/doc/generated/examples/nodes_print_2.xml b/doc/generated/examples/nodes_print_2.xml index a62b522..3c66573 100644 --- a/doc/generated/examples/nodes_print_2.xml +++ b/doc/generated/examples/nodes_print_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q The object file is: hello.obj The program file is: hello.exe cl /Fohello.obj /c hello.c /nologo diff --git a/doc/generated/examples/output_Progress-TARGET_1.xml b/doc/generated/examples/output_Progress-TARGET_1.xml index b233c6e..3408cdc 100644 --- a/doc/generated/examples/output_Progress-TARGET_1.xml +++ b/doc/generated/examples/output_Progress-TARGET_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q Evaluating SConstruct Evaluating f1.c Evaluating f1.o diff --git a/doc/generated/examples/output_ex1_1.xml b/doc/generated/examples/output_ex1_1.xml index 535960b..bff25da 100644 --- a/doc/generated/examples/output_ex1_1.xml +++ b/doc/generated/examples/output_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -h +% scons -h scons: Reading SConscript files ... scons: done reading SConscript files. diff --git a/doc/generated/examples/output_ex2_1.xml b/doc/generated/examples/output_ex2_1.xml index e951c3a..5d02707 100644 --- a/doc/generated/examples/output_ex2_1.xml +++ b/doc/generated/examples/output_ex2_1.xml @@ -1,5 +1,4 @@ - -C:\>scons -h +C:\>scons -h scons: Reading SConscript files ... scons: done reading SConscript files. diff --git a/doc/generated/examples/output_ex2_2.xml b/doc/generated/examples/output_ex2_2.xml index 8dca6c3..5a25472 100644 --- a/doc/generated/examples/output_ex2_2.xml +++ b/doc/generated/examples/output_ex2_2.xml @@ -1,5 +1,4 @@ - -% scons -h +% scons -h scons: Reading SConscript files ... scons: done reading SConscript files. diff --git a/doc/generated/examples/output_gbf2_1.xml b/doc/generated/examples/output_gbf2_1.xml index c31b41a..267035e 100644 --- a/doc/generated/examples/output_gbf2_1.xml +++ b/doc/generated/examples/output_gbf2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q scons: `.' is up to date. Build succeeded. % scons -Q fail=1 diff --git a/doc/generated/examples/parseflags_ex1_1.xml b/doc/generated/examples/parseflags_ex1_1.xml index d6e4d96..bfa731f 100644 --- a/doc/generated/examples/parseflags_ex1_1.xml +++ b/doc/generated/examples/parseflags_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/parseflags_ex1_2.xml b/doc/generated/examples/parseflags_ex1_2.xml index 4c115d0..d9f00a5 100644 --- a/doc/generated/examples/parseflags_ex1_2.xml +++ b/doc/generated/examples/parseflags_ex1_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/parseflags_ex2_1.xml b/doc/generated/examples/parseflags_ex2_1.xml index da84ee3..0a35925 100644 --- a/doc/generated/examples/parseflags_ex2_1.xml +++ b/doc/generated/examples/parseflags_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q CCFLAGS -whatever cc -o f1.o -c -whatever f1.c cc -o f1 f1.o diff --git a/doc/generated/examples/parseflags_ex3_1.xml b/doc/generated/examples/parseflags_ex3_1.xml index d6e4d96..bfa731f 100644 --- a/doc/generated/examples/parseflags_ex3_1.xml +++ b/doc/generated/examples/parseflags_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/parseflags_ex4_1.xml b/doc/generated/examples/parseflags_ex4_1.xml index d6e4d96..bfa731f 100644 --- a/doc/generated/examples/parseflags_ex4_1.xml +++ b/doc/generated/examples/parseflags_ex4_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q CPPPATH ['/opt/include'] LIBPATH ['/opt/lib'] LIBS ['foo'] diff --git a/doc/generated/examples/repositories_CPPPATH3_1.xml b/doc/generated/examples/repositories_CPPPATH3_1.xml index d53ffdb..f983d96 100644 --- a/doc/generated/examples/repositories_CPPPATH3_1.xml +++ b/doc/generated/examples/repositories_CPPPATH3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c -Idir1 -I/r1/dir1 -I/r2/dir1 -Idir2 -I/r1/dir2 -I/r2/dir2 -Idir3 -I/r1/dir3 -I/r2/dir3 hello.c cc -o hello hello.o diff --git a/doc/generated/examples/repositories_CPPPATH_1.xml b/doc/generated/examples/repositories_CPPPATH_1.xml index 6c5a2d1..30b5d75 100644 --- a/doc/generated/examples/repositories_CPPPATH_1.xml +++ b/doc/generated/examples/repositories_CPPPATH_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c -I. -I/usr/repository1 hello.c cc -o hello hello.o diff --git a/doc/generated/examples/repositories_ex1_1.xml b/doc/generated/examples/repositories_ex1_1.xml index a21fdc8..efc6d5a 100644 --- a/doc/generated/examples/repositories_ex1_1.xml +++ b/doc/generated/examples/repositories_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c hello.c cc -o hello hello.o diff --git a/doc/generated/examples/repositories_ex2_1.xml b/doc/generated/examples/repositories_ex2_1.xml index 819c936..e773a8d 100644 --- a/doc/generated/examples/repositories_ex2_1.xml +++ b/doc/generated/examples/repositories_ex2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c /usr/repository1/hello.c cc -o hello hello.o diff --git a/doc/generated/examples/repositories_ex3_1.xml b/doc/generated/examples/repositories_ex3_1.xml index 76d69cd..c437bb7 100644 --- a/doc/generated/examples/repositories_ex3_1.xml +++ b/doc/generated/examples/repositories_ex3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c /usr/repository2/hello.c cc -o hello hello.o diff --git a/doc/generated/examples/repositories_ex4_1.xml b/doc/generated/examples/repositories_ex4_1.xml index 8911683..47d9923 100644 --- a/doc/generated/examples/repositories_ex4_1.xml +++ b/doc/generated/examples/repositories_ex4_1.xml @@ -1,5 +1,4 @@ - -% cd /usr/repository1 +% cd /usr/repository1 % scons -Q cc -o file1.o -c file1.c cc -o file2.o -c file2.c diff --git a/doc/generated/examples/repositories_quote1_1.xml b/doc/generated/examples/repositories_quote1_1.xml index d2ba624..c503900 100644 --- a/doc/generated/examples/repositories_quote1_1.xml +++ b/doc/generated/examples/repositories_quote1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o hello.o -c -I. -I/usr/repository1 /usr/repository1/hello.c cc -o hello hello.o diff --git a/doc/generated/examples/separate_builddir_1.xml b/doc/generated/examples/separate_builddir_1.xml index a763172..36d4383 100644 --- a/doc/generated/examples/separate_builddir_1.xml +++ b/doc/generated/examples/separate_builddir_1.xml @@ -1,5 +1,4 @@ - -% ls src +% ls src hello.c % scons -Q cc -o build/hello.o -c build/hello.c diff --git a/doc/generated/examples/separate_builddir_sconscript_1.xml b/doc/generated/examples/separate_builddir_sconscript_1.xml index 5694a56..d719829 100644 --- a/doc/generated/examples/separate_builddir_sconscript_1.xml +++ b/doc/generated/examples/separate_builddir_sconscript_1.xml @@ -1,5 +1,4 @@ - -% ls src +% ls src SConscript hello.c % scons -Q cc -o build/hello.o -c build/hello.c diff --git a/doc/generated/examples/separate_duplicate0_1.xml b/doc/generated/examples/separate_duplicate0_1.xml index 207c5d7..3c8b642 100644 --- a/doc/generated/examples/separate_duplicate0_1.xml +++ b/doc/generated/examples/separate_duplicate0_1.xml @@ -1,5 +1,4 @@ - -% ls src +% ls src hello.c % scons -Q cc -o build/hello.o -c src/hello.c diff --git a/doc/generated/examples/separate_ex1_1.xml b/doc/generated/examples/separate_ex1_1.xml index 5694a56..d719829 100644 --- a/doc/generated/examples/separate_ex1_1.xml +++ b/doc/generated/examples/separate_ex1_1.xml @@ -1,5 +1,4 @@ - -% ls src +% ls src SConscript hello.c % scons -Q cc -o build/hello.o -c build/hello.c diff --git a/doc/generated/examples/separate_glob_builddir_sconscript_1.xml b/doc/generated/examples/separate_glob_builddir_sconscript_1.xml index 7cdb420..4ff49d5 100644 --- a/doc/generated/examples/separate_glob_builddir_sconscript_1.xml +++ b/doc/generated/examples/separate_glob_builddir_sconscript_1.xml @@ -1,5 +1,4 @@ - -% ls src +% ls src SConscript f1.c f2.c f2.h % scons -Q cc -o build/f1.o -c build/f1.c diff --git a/doc/generated/examples/sideeffect_parallel_1.xml b/doc/generated/examples/sideeffect_parallel_1.xml index 9478c52..0152803 100644 --- a/doc/generated/examples/sideeffect_parallel_1.xml +++ b/doc/generated/examples/sideeffect_parallel_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --jobs=2 +% scons -Q --jobs=2 echo > file1.out data1 echo > file2.out data2 diff --git a/doc/generated/examples/sideeffect_shared_1.xml b/doc/generated/examples/sideeffect_shared_1.xml index 2abb806..355578a 100644 --- a/doc/generated/examples/sideeffect_shared_1.xml +++ b/doc/generated/examples/sideeffect_shared_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --jobs=2 +% scons -Q --jobs=2 ./build --log logfile.txt file1.in file1.out ./build --log logfile.txt file2.in file2.out diff --git a/doc/generated/examples/sideeffect_simple_1.xml b/doc/generated/examples/sideeffect_simple_1.xml index e88630c..ed97594 100644 --- a/doc/generated/examples/sideeffect_simple_1.xml +++ b/doc/generated/examples/sideeffect_simple_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --jobs=2 +% scons -Q --jobs=2 File "/home/my/project/SConstruct", line 4 'echo >$TARGET data1; echo >log updated file1')) diff --git a/doc/generated/examples/simple_Object_1.xml b/doc/generated/examples/simple_Object_1.xml index 6d5c80d..0dfb85a 100644 --- a/doc/generated/examples/simple_Object_1.xml +++ b/doc/generated/examples/simple_Object_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_Object_2.xml b/doc/generated/examples/simple_Object_2.xml index 3686006..b7dea0c 100644 --- a/doc/generated/examples/simple_Object_2.xml +++ b/doc/generated/examples/simple_Object_2.xml @@ -1,5 +1,4 @@ - -C:\>scons +C:\>scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_clean_1.xml b/doc/generated/examples/simple_clean_1.xml index 21adbe7..c15ec25 100644 --- a/doc/generated/examples/simple_clean_1.xml +++ b/doc/generated/examples/simple_clean_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_clean_2.xml b/doc/generated/examples/simple_clean_2.xml index 26f3c37..7e3d564 100644 --- a/doc/generated/examples/simple_clean_2.xml +++ b/doc/generated/examples/simple_clean_2.xml @@ -1,5 +1,4 @@ - -C:\>scons +C:\>scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_declarative_1.xml b/doc/generated/examples/simple_declarative_1.xml index 01061cf..da29097 100644 --- a/doc/generated/examples/simple_declarative_1.xml +++ b/doc/generated/examples/simple_declarative_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... Calling Program('hello.c') Calling Program('goodbye.c') diff --git a/doc/generated/examples/simple_ex1_1.xml b/doc/generated/examples/simple_ex1_1.xml index 5833ede..f645a2a 100644 --- a/doc/generated/examples/simple_ex1_1.xml +++ b/doc/generated/examples/simple_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_ex1_2.xml b/doc/generated/examples/simple_ex1_2.xml index f0e07a1..518b437 100644 --- a/doc/generated/examples/simple_ex1_2.xml +++ b/doc/generated/examples/simple_ex1_2.xml @@ -1,5 +1,4 @@ - -C:\>scons +C:\>scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_ex1_3.xml b/doc/generated/examples/simple_ex1_3.xml index f0e07a1..518b437 100644 --- a/doc/generated/examples/simple_ex1_3.xml +++ b/doc/generated/examples/simple_ex1_3.xml @@ -1,5 +1,4 @@ - -C:\>scons +C:\>scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/simple_ex1_4.xml b/doc/generated/examples/simple_ex1_4.xml index 80c7b63..eb10a06 100644 --- a/doc/generated/examples/simple_ex1_4.xml +++ b/doc/generated/examples/simple_ex1_4.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q +C:\>scons -Q cl /Fohello.obj /c hello.c /nologo link /nologo /OUT:hello.exe hello.obj embedManifestExeCheck(target, source, env) diff --git a/doc/generated/examples/simple_java_1.xml b/doc/generated/examples/simple_java_1.xml index 75cc6cc..decf1b5 100644 --- a/doc/generated/examples/simple_java_1.xml +++ b/doc/generated/examples/simple_java_1.xml @@ -1,5 +1,4 @@ - -% scons +% scons scons: Reading SConscript files ... scons: done reading SConscript files. scons: Building targets ... diff --git a/doc/generated/examples/tasks_ex1_1.xml b/doc/generated/examples/tasks_ex1_1.xml index 4885fde..0bbbae1 100644 --- a/doc/generated/examples/tasks_ex1_1.xml +++ b/doc/generated/examples/tasks_ex1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cat < test.bar > test.h cc -o app main.cpp cat < foo.bar2 > foo.cpp diff --git a/doc/generated/examples/troubleshoot_Dump_1.xml b/doc/generated/examples/troubleshoot_Dump_1.xml index 1f6f250..513babe 100644 --- a/doc/generated/examples/troubleshoot_Dump_1.xml +++ b/doc/generated/examples/troubleshoot_Dump_1.xml @@ -1,7 +1,8 @@ - -% scons +% scons scons: Reading SConscript files ... -{ 'BUILDERS': {'_InternalInstall': <function InstallBuilderWrapper at 0x700000>, '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>}, +{ 'BUILDERS': { '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, + '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>, + '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>}, 'CONFIGUREDIR': '#/.sconf_temp', 'CONFIGURELOG': '#/config.log', 'CPPSUFFIXES': [ '.c', @@ -27,7 +28,7 @@ scons: Reading SConscript files ... 'DSUFFIXES': ['.d'], 'Dir': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'Dirs': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, - 'ENV': { 'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'}, + 'ENV': {'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'}, 'ESCAPE': <function escape at 0x700000>, 'File': <SCons.Defaults.Variable_Method_Caller object at 0x700000>, 'HOST_ARCH': None, @@ -60,9 +61,12 @@ scons: Reading SConscript files ... 'TEMPFILEARGJOIN': ' ', 'TEMPFILEPREFIX': '@', 'TOOLS': ['install', 'install'], - '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, __env__)}', - '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', - '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', + '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, ' + '__env__)}', + '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, ' + 'TARGET, SOURCE)} $)', + '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, ' + 'RDirs, TARGET, SOURCE)} $)', '_LIBFLAGS': '${_concat(LIBLINKPREFIX, LIBS, LIBLINKSUFFIX, __env__)}', '__DRPATH': '$_DRPATH', '__DSHLIBVERSIONFLAGS': '${__libversionflags(__env__,"DSHLIBVERSION","_DSHLIBVERSIONFLAGS")}', diff --git a/doc/generated/examples/troubleshoot_Dump_2.xml b/doc/generated/examples/troubleshoot_Dump_2.xml index 4b8aa0b..357ecfd 100644 --- a/doc/generated/examples/troubleshoot_Dump_2.xml +++ b/doc/generated/examples/troubleshoot_Dump_2.xml @@ -1,11 +1,18 @@ - -C:\>scons +C:\>scons scons: Reading SConscript files ... -{ 'BUILDERS': {'_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>, '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, 'Object': <SCons.Builder.CompositeBuilder object at 0x700000>, 'PCH': <SCons.Builder.BuilderBase object at 0x700000>, 'RES': <SCons.Builder.BuilderBase object at 0x700000>, 'SharedObject': <SCons.Builder.CompositeBuilder object at 0x700000>, 'StaticObject': <SCons.Builder.CompositeBuilder object at 0x700000>, '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>}, +{ 'BUILDERS': { 'Object': <SCons.Builder.CompositeBuilder object at 0x700000>, + 'PCH': <SCons.Builder.BuilderBase object at 0x700000>, + 'RES': <SCons.Builder.BuilderBase object at 0x700000>, + 'SharedObject': <SCons.Builder.CompositeBuilder object at 0x700000>, + 'StaticObject': <SCons.Builder.CompositeBuilder object at 0x700000>, + '_InternalInstall': <function InstallBuilderWrapper at 0x700000>, + '_InternalInstallAs': <function InstallAsBuilderWrapper at 0x700000>, + '_InternalInstallVersionedLib': <function InstallVersionedBuilderWrapper at 0x700000>}, 'CC': 'cl', 'CCCOM': <SCons.Action.FunctionAction object at 0x700000>, 'CCFLAGS': ['/nologo'], - 'CCPCHFLAGS': ['${(PCH and "/Yu%s \\"/Fp%s\\""%(PCHSTOP or "",File(PCH))) or ""}'], + 'CCPCHFLAGS': [ '${(PCH and "/Yu%s \\"/Fp%s\\""%(PCHSTOP or "",File(PCH))) ' + 'or ""}'], 'CCPDBFLAGS': ['${(PDB and "/Z7") or ""}'], 'CFILESUFFIX': '.c', 'CFLAGS': [], @@ -34,7 +41,8 @@ scons: Reading SConscript files ... '.SPP', '.sx'], 'CXX': '$CC', - 'CXXCOM': '${TEMPFILE("$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS $CCFLAGS $_CCCOMCOM","$CXXCOMSTR")}', + 'CXXCOM': '${TEMPFILE("$CXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $CXXFLAGS ' + '$CCFLAGS $_CCCOMCOM","$CXXCOMSTR")}', 'CXXFILESUFFIX': '.cc', 'CXXFLAGS': ['$(', '/TP', '$)'], 'DSUFFIXES': ['.d'], @@ -61,7 +69,9 @@ scons: Reading SConscript files ... 'MSVC_SETUP_RUN': True, 'OBJPREFIX': '', 'OBJSUFFIX': '.obj', - 'PCHCOM': '$CXX /Fo${TARGETS[1]} $CXXFLAGS $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS /c $SOURCES /Yc$PCHSTOP /Fp${TARGETS[0]} $CCPDBFLAGS $PCHPDBFLAGS', + 'PCHCOM': '$CXX /Fo${TARGETS[1]} $CXXFLAGS $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS ' + '$_CPPINCFLAGS /c $SOURCES /Yc$PCHSTOP /Fp${TARGETS[0]} ' + '$CCPDBFLAGS $PCHPDBFLAGS', 'PCHPDBFLAGS': ['${(PDB and "/Yd") or ""}'], 'PLATFORM': 'win32', 'PROGPREFIX': '', @@ -78,9 +88,10 @@ scons: Reading SConscript files ... 'SHCCFLAGS': ['$CCFLAGS'], 'SHCFLAGS': ['$CFLAGS'], 'SHCXX': '$CXX', - 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES $SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM","$SHCXXCOMSTR")}', + 'SHCXXCOM': '${TEMPFILE("$SHCXX $_MSVC_OUTPUT_FLAG /c $CHANGED_SOURCES ' + '$SHCXXFLAGS $SHCCFLAGS $_CCCOMCOM","$SHCXXCOMSTR")}', 'SHCXXFLAGS': ['$CXXFLAGS'], - 'SHELL': None, + 'SHELL': 'command', 'SHLIBPREFIX': '', 'SHLIBSUFFIX': '.dll', 'SHOBJPREFIX': '$OBJPREFIX', @@ -93,10 +104,14 @@ scons: Reading SConscript files ... 'TEMPFILEARGJOIN': '\n', 'TEMPFILEPREFIX': '@', 'TOOLS': ['msvc', 'install', 'install'], + 'VSWHERE': None, '_CCCOMCOM': '$CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $CCPCHFLAGS $CCPDBFLAGS', - '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, __env__)}', - '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', - '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, RDirs, TARGET, SOURCE)} $)', + '_CPPDEFFLAGS': '${_defines(CPPDEFPREFIX, CPPDEFINES, CPPDEFSUFFIX, ' + '__env__)}', + '_CPPINCFLAGS': '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs, ' + 'TARGET, SOURCE)} $)', + '_LIBDIRFLAGS': '$( ${_concat(LIBDIRPREFIX, LIBPATH, LIBDIRSUFFIX, __env__, ' + 'RDirs, TARGET, SOURCE)} $)', '_LIBFLAGS': '${_concat(LIBLINKPREFIX, LIBS, LIBLINKSUFFIX, __env__)}', '_MSVC_OUTPUT_FLAG': <function msvc_output_flag at 0x700000>, '__DSHLIBVERSIONFLAGS': '${__libversionflags(__env__,"DSHLIBVERSION","_DSHLIBVERSIONFLAGS")}', diff --git a/doc/generated/examples/troubleshoot_Dump_ENV_1.xml b/doc/generated/examples/troubleshoot_Dump_ENV_1.xml index 786491f..7ed4d86 100644 --- a/doc/generated/examples/troubleshoot_Dump_ENV_1.xml +++ b/doc/generated/examples/troubleshoot_Dump_ENV_1.xml @@ -1,7 +1,6 @@ - -% scons +% scons scons: Reading SConscript files ... -{ 'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'} +{'PATH': '/usr/local/bin:/opt/bin:/bin:/usr/bin'} scons: done reading SConscript files. scons: Building targets ... scons: `.' is up to date. diff --git a/doc/generated/examples/troubleshoot_Dump_ENV_2.xml b/doc/generated/examples/troubleshoot_Dump_ENV_2.xml index b91c31c..e421f6a 100644 --- a/doc/generated/examples/troubleshoot_Dump_ENV_2.xml +++ b/doc/generated/examples/troubleshoot_Dump_ENV_2.xml @@ -1,5 +1,4 @@ - -C:\>scons +C:\>scons scons: Reading SConscript files ... { 'PATH': 'C:\\WINDOWS\\System32:/usr/bin', 'PATHEXT': '.COM;.EXE;.BAT;.CMD', diff --git a/doc/generated/examples/troubleshoot_explain1_1.xml b/doc/generated/examples/troubleshoot_explain1_1.xml index 2a9547d..c73e5ac 100644 --- a/doc/generated/examples/troubleshoot_explain1_1.xml +++ b/doc/generated/examples/troubleshoot_explain1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cp file.in file.oout % scons -Q cp file.in file.oout diff --git a/doc/generated/examples/troubleshoot_explain1_2.xml b/doc/generated/examples/troubleshoot_explain1_2.xml index 9864cd7..77eb88b 100644 --- a/doc/generated/examples/troubleshoot_explain1_2.xml +++ b/doc/generated/examples/troubleshoot_explain1_2.xml @@ -1,5 +1,4 @@ - -% scons -Q --debug=explain +% scons -Q --debug=explain scons: building `file.out' because it doesn't exist cp file.in file.oout diff --git a/doc/generated/examples/troubleshoot_explain1_3.xml b/doc/generated/examples/troubleshoot_explain1_3.xml index ebc13f8..f927648 100644 --- a/doc/generated/examples/troubleshoot_explain1_3.xml +++ b/doc/generated/examples/troubleshoot_explain1_3.xml @@ -1,7 +1,6 @@ - -% scons -Q --warn=target-not-built +% scons -Q --warn=target-not-built cp file.in file.oout scons: warning: Cannot find target file.out after building -File "/home/bdeegan/devel/scons/git/as_scons/src/script/scons.py", line 204, in <module> +File "/home/mats/github/scons/scripts/scons.py", line 96, in <module> diff --git a/doc/generated/examples/troubleshoot_explain2_1.xml b/doc/generated/examples/troubleshoot_explain2_1.xml index cd95a44..80fefda 100644 --- a/doc/generated/examples/troubleshoot_explain2_1.xml +++ b/doc/generated/examples/troubleshoot_explain2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o file1.o -c file1.c cc -o file2.o -c file2.c cc -o file3.o -c file3.c diff --git a/doc/generated/examples/troubleshoot_explain3_1.xml b/doc/generated/examples/troubleshoot_explain3_1.xml index bacb7e8..4fde5ac 100644 --- a/doc/generated/examples/troubleshoot_explain3_1.xml +++ b/doc/generated/examples/troubleshoot_explain3_1.xml @@ -1,5 +1,4 @@ - -% scons -Q +% scons -Q cc -o file1.o -c -I. file1.c cc -o file2.o -c -I. file2.c cc -o file3.o -c -I. file3.c diff --git a/doc/generated/examples/troubleshoot_findlibs_1.xml b/doc/generated/examples/troubleshoot_findlibs_1.xml index 8fc4e5f..9fddc2b 100644 --- a/doc/generated/examples/troubleshoot_findlibs_1.xml +++ b/doc/generated/examples/troubleshoot_findlibs_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --debug=findlibs +% scons -Q --debug=findlibs findlibs: looking for 'libfoo.a' in 'libs1' ... findlibs: ... FOUND 'libfoo.a' in 'libs1' findlibs: looking for 'libfoo.so' in 'libs1' ... diff --git a/doc/generated/examples/troubleshoot_stacktrace_1.xml b/doc/generated/examples/troubleshoot_stacktrace_1.xml index cc3ca7b..464eca5 100644 --- a/doc/generated/examples/troubleshoot_stacktrace_1.xml +++ b/doc/generated/examples/troubleshoot_stacktrace_1.xml @@ -1,4 +1,3 @@ - -% scons -Q +% scons -Q scons: *** [prog.o] Source `prog.c' not found, needed by target `prog.o'. diff --git a/doc/generated/examples/troubleshoot_stacktrace_2.xml b/doc/generated/examples/troubleshoot_stacktrace_2.xml index 7ace0ec..79cf5b5 100644 --- a/doc/generated/examples/troubleshoot_stacktrace_2.xml +++ b/doc/generated/examples/troubleshoot_stacktrace_2.xml @@ -1,12 +1,12 @@ % scons -Q --debug=stacktrace scons: *** [prog.o] Source `prog.c' not found, needed by target `prog.o'. scons: internal stack trace: - File "src/engine/SCons/Job.py", line 199, in start + File "SCons/Job.py", line 199, in start task.prepare() - File "src/engine/SCons/Script/Main.py", line 189, in prepare + File "SCons/Script/Main.py", line 189, in prepare return SCons.Taskmaster.OutOfDateTask.prepare(self) - File "src/engine/SCons/Taskmaster.py", line 196, in prepare + File "SCons/Taskmaster.py", line 196, in prepare executor.prepare() - File "src/engine/SCons/Executor.py", line 429, in prepare + File "SCons/Executor.py", line 429, in prepare raise SCons.Errors.StopError(msg % (s, self.batches[0].targets[0])) diff --git a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml index 578951d..cfa2c8b 100644 --- a/doc/generated/examples/troubleshoot_taskmastertrace_1.xml +++ b/doc/generated/examples/troubleshoot_taskmastertrace_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --taskmastertrace=- prog +% scons -Q --taskmastertrace=- prog Taskmaster: Looking for a node to evaluate Taskmaster: Considering node <no_state 0 'prog'> and its children: diff --git a/doc/generated/examples/troubleshoot_tree1_1.xml b/doc/generated/examples/troubleshoot_tree1_1.xml index 4ccadc6..0f3c3c8 100644 --- a/doc/generated/examples/troubleshoot_tree1_1.xml +++ b/doc/generated/examples/troubleshoot_tree1_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --tree=all +% scons -Q --tree=all cc -o f1.o -c -I. f1.c cc -o f2.o -c -I. f2.c cc -o f3.o -c -I. f3.c diff --git a/doc/generated/examples/troubleshoot_tree2_1.xml b/doc/generated/examples/troubleshoot_tree2_1.xml index 85febf5..e7e2d5d 100644 --- a/doc/generated/examples/troubleshoot_tree2_1.xml +++ b/doc/generated/examples/troubleshoot_tree2_1.xml @@ -1,5 +1,4 @@ - -% scons -Q --tree=all +% scons -Q --tree=all cc -o f1.o -c -I. f1.c cc -o f2.o -c -I. f2.c cc -o f3.o -c -I. f3.c diff --git a/doc/generated/examples/troubleshoot_tree2_2.xml b/doc/generated/examples/troubleshoot_tree2_2.xml index 5380fad..c2f0e64 100644 --- a/doc/generated/examples/troubleshoot_tree2_2.xml +++ b/doc/generated/examples/troubleshoot_tree2_2.xml @@ -1,5 +1,4 @@ - -% scons -Q --tree=prune +% scons -Q --tree=prune cc -o f1.o -c -I. f1.c cc -o f2.o -c -I. f2.c cc -o f3.o -c -I. f3.c diff --git a/doc/generated/examples/variants_ex_1.xml b/doc/generated/examples/variants_ex_1.xml index 12a14d6..b51655c 100644 --- a/doc/generated/examples/variants_ex_1.xml +++ b/doc/generated/examples/variants_ex_1.xml @@ -1,5 +1,4 @@ - -% scons -Q OS=linux +% scons -Q OS=linux Install file: "build/linux/world/world.h" as "export/linux/include/world.h" cc -o build/linux/hello/hello.o -c -Iexport/linux/include build/linux/hello/hello.c cc -o build/linux/world/world.o -c -Iexport/linux/include build/linux/world/world.c diff --git a/doc/generated/examples/variants_ex_2.xml b/doc/generated/examples/variants_ex_2.xml index c129cc4..22385e3 100644 --- a/doc/generated/examples/variants_ex_2.xml +++ b/doc/generated/examples/variants_ex_2.xml @@ -1,5 +1,4 @@ - -C:\>scons -Q OS=windows +C:\>scons -Q OS=windows Install file: "build/windows/world/world.h" as "export/windows/include/world.h" cl /Fobuild\windows\hello\hello.obj /c build\windows\hello\hello.c /nologo /Iexport\windows\include cl /Fobuild\windows\world\world.obj /c build\windows\world\world.c /nologo /Iexport\windows\include diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index d71387e..5dc356e 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -1,4 +1,3 @@ - %scons; @@ -12,16 +11,11 @@ %variables-mod; ]> - + - - Action(action, [cmd/str/fun, [var, ...]] [option=value, ...]) - - - env.Action(action, [cmd/str/fun, [var, ...]] [option=value, ...]) - - - + Action(action, [cmd/str/fun, [var, ...]] [option=value, ...]) + env.Action(action, [cmd/str/fun, [var, ...]] [option=value, ...]) + Creates an Action object for the specified action. @@ -29,7 +23,7 @@ See the manpage section "Action Objects" for a complete explanation of the arguments and behavior. - + Note that the env.Action() form of the invocation will expand @@ -50,14 +44,9 @@ until the Action object is actually used. - - AddMethod(object, function, [name]) - - - env.AddMethod(function, [name]) - - - + AddMethod(object, function, [name]) + env.AddMethod(function, [name]) + When called with the AddMethod() form, @@ -86,11 +75,11 @@ specified itself is used for the method name. - + Examples: - + # Note that the first argument to the function to # be attached as a method must be the object through # which the method will be called; the Python @@ -113,11 +102,8 @@ env.other_method_name('another arg') - - AddOption(arguments) - - - + AddOption(arguments) + This function adds a new command-line option to be recognized. The specified arguments @@ -129,12 +115,12 @@ see the documentation for for a thorough discussion of its option-processing capabities. - + In addition to the arguments and values supported by the optparse.add_option() method, the SCons -AddOption +AddOption function allows you to set the nargs keyword value to @@ -146,7 +132,7 @@ argument. When nargs = '?' is passed to the -AddOption +AddOption function, the const keyword argument @@ -156,29 +142,29 @@ option is specified on the command line without an explicit argument. - + If no default= keyword argument is supplied when calling -AddOption, +AddOption, the option will have a default value of None. - + Unlike regular optparse, option names added via AddOption must be matched exactly, the automatic matching of abbreviations on the command line for long options is not supported. To allow specific abbreviations, -include them in the AddOption call. +include them in the AddOption call. - + Once a new command-line option has been added with -AddOption, +AddOption, the option value may be accessed using -GetOption +GetOption or env.GetOption(). -SetOption is not currently supported for -options added with AddOption. +SetOption is not currently supported for +options added with AddOption. - + Any specified help= strings for the new option(s) @@ -210,22 +196,22 @@ options (the latter only if no other help text is specified in the SConscript files). The help text for the local options specified by -AddOption +AddOption will appear below the SCons options themselves, under a separate Local Options heading. The options will appear in the help text in the order in which the -AddOption +AddOption calls occur. - + Example: - + AddOption('--prefix', dest='prefix', nargs=1, type='string', @@ -235,12 +221,12 @@ AddOption('--prefix', env = Environment(PREFIX = GetOption('prefix')) - + -While AddOption behaves like +While AddOption behaves like add_option, from the optparse module, -the behavior of options added by AddOption +the behavior of options added by AddOption which take arguments is underfined in scons if whitespace (rather than an = sign) is used as @@ -253,14 +239,9 @@ Such usage should be avoided. - - AddPostAction(target, action) - - - env.AddPostAction(target, action) - - - + AddPostAction(target, action) + env.AddPostAction(target, action) + Arranges for the specified action to be performed @@ -274,7 +255,7 @@ See the manpage section "Action Objects" for a complete explanation. - + When multiple targets are supplied, the action may be called multiple times, once after each action that generates @@ -283,14 +264,9 @@ one or more targets in the list. - - AddPreAction(target, action) - - - env.AddPreAction(target, action) - - - + AddPreAction(target, action) + env.AddPreAction(target, action) + Arranges for the specified action to be performed @@ -304,14 +280,14 @@ See the manpage section "Action Objects" for a complete explanation. - + When multiple targets are specified, the action(s) may be called multiple times, once before each action that generates one or more targets in the list. - + Note that if any of the targets are built in multiple steps, the action will be invoked just before the "final" action that specifically @@ -322,16 +298,16 @@ from a specified source file via an intermediate object file: - + foo = Program('foo.c') AddPreAction(foo, 'pre_action') - + The specified pre_action would be executed before -scons +scons calls the link command that actually generates the executable program binary foo, @@ -342,14 +318,9 @@ file into an object file. - - Alias(alias, [targets, [action]]) - - - env.Alias(alias, [targets, [action]]) - - - + Alias(alias, [targets, [action]]) + env.Alias(alias, [targets, [action]]) + Creates one or more phony targets that expand to one or more other targets. An optional @@ -363,17 +334,19 @@ which exists outside of any file system. This Node object, or the alias name, may be used as a dependency of any other target, including another alias. -Alias +Alias can be called multiple times for the same alias to add additional targets to the alias, or additional actions to the list for this alias. +Aliases are global even if set through +the construction environment method. - + Examples: - + Alias('install') Alias('install', '/usr/bin') Alias(['install', 'install-lib'], '/usr/local/lib') @@ -386,11 +359,8 @@ env.Alias('update', ['file1', 'file2'], "update_database $SOURCES") - - AllowSubstExceptions([exception, ...]) - - - + AllowSubstExceptions([exception, ...]) + Specifies the exceptions that will be allowed when expanding construction variables. By default, @@ -400,25 +370,25 @@ or IndexError exception will expand to a '' -(a null string) and not cause scons to fail. +(an empty string) and not cause scons to fail. All exceptions not in the specified list will generate an error message and terminate processing. - + If -AllowSubstExceptions +AllowSubstExceptions is called multiple times, each call completely overwrites the previous list of allowed exceptions. - + Example: - + # Requires that all construction variable names exist. # (You may wish to do this if you want to enforce strictly # that all construction variables must be defined before use.) @@ -431,20 +401,15 @@ AllowSubstExceptions(IndexError, NameError, ZeroDivisionError) - - AlwaysBuild(target, ...) - - - env.AlwaysBuild(target, ...) - - - + AlwaysBuild(target, ...) + env.AlwaysBuild(target, ...) + Marks each given target so that it is always assumed to be out of date, and will always be rebuilt if needed. Note, however, that -AlwaysBuild +AlwaysBuild does not add its target(s) to the default target list, so the targets will only be built if they are specified on the command line, @@ -453,16 +418,13 @@ they will always be built if so specified. Multiple targets can be passed in to a single call to -AlwaysBuild. +AlwaysBuild. - - env.Append(key=val, [...]) - - - + env.Append(key=val, [...]) + Appends the specified keyword arguments to the end of construction variables in the environment. If the Environment does not have @@ -475,24 +437,21 @@ Otherwise, the construction variable and the value of the keyword argument are both coerced to lists, and the lists are added together. -(See also the Prepend method). +(See also the Prepend method). - + Example: - + env.Append(CCFLAGS = ' -g', FOO = ['foo.yyy']) - - env.AppendENVPath(name, newpath, [envname, sep, delete_existing]) - - - + env.AppendENVPath(name, newpath, [envname, sep, delete_existing]) + This appends new path elements to the given path in the specified external environment (ENV @@ -510,18 +469,18 @@ case where the given old path variable is a list instead of a string, in which case a list will be returned instead of a string. - + If delete_existing is 0, then adding a path that already exists will not move it to the end; it will stay where it is in the list. - + Example: - + print 'before:',env['ENV']['INCLUDE'] include_path = '/foo/bar:/foo' env.AppendENVPath('INCLUDE', include_path) @@ -534,11 +493,8 @@ after: /biz:/foo/bar:/foo - - env.AppendUnique(key=val, [...], delete_existing=0) - - - + env.AppendUnique(key=val, [...], delete_existing=0) + Appends the specified keyword arguments to the end of construction variables in the environment. If the Environment does not have @@ -554,24 +510,19 @@ existing matching values are removed first, so existing values in the arg list move to the end of the list. - + Example: - + env.AppendUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) - - Builder(action, [arguments]) - - - env.Builder(action, [arguments]) - - - + Builder(action, [arguments]) + env.Builder(action, [arguments]) + Creates a Builder object for the specified action. @@ -579,7 +530,7 @@ See the manpage section "Builder Objects" for a complete explanation of the arguments and behavior. - + Note that the env.Builder() form of the invocation will expand @@ -594,28 +545,23 @@ construction environment through which env.Builder() was called. The -Builder +Builder form delays all variable expansion until after the Builder object is actually called. - - CacheDir(cache_dir) - - - env.CacheDir(cache_dir) - - - + CacheDir(cache_dir) + env.CacheDir(cache_dir) + Specifies that -scons +scons will maintain a cache of derived files in cache_dir. The derived files in the cache will be shared among all the builds using the same -CacheDir +CacheDir call. Specifying a cache_dir @@ -624,13 +570,13 @@ of disables derived file caching. - + Calling env.CacheDir() will only affect targets built through the specified construction environment. Calling -CacheDir +CacheDir sets a global default that will be used by all targets built through construction environments @@ -641,21 +587,21 @@ have an specified. - + When a CacheDir() is being used and -scons +scons finds a derived file that needs to be rebuilt, it will first look in the cache to see if a derived file has already been built from identical input files and an identical build action (as incorporated into the MD5 build signature). If so, -scons +scons will retrieve the file from the cache. If the derived file is not present in the cache, -scons +scons will rebuild it and then place a copy of the built file in the cache (identified by its MD5 build signature), @@ -664,20 +610,20 @@ builds that need to build the same derived file from identical inputs. - + Use of a specified -CacheDir +CacheDir may be disabled for any invocation by using the option. - + If the option is used, -scons +scons will place a copy of all derived files in the cache, @@ -685,17 +631,17 @@ even if they already existed and were not built by this invocation. This is useful to populate a cache the first time -CacheDir +CacheDir is added to a build, or after using the option. - + When using -CacheDir, -scons +CacheDir, +scons will report, "Retrieved `file' from cache," unless the @@ -704,7 +650,7 @@ option is being used. When the option is used, -scons +scons will print the action that would have been used to build the file, @@ -716,9 +662,9 @@ a given derived file has been built in-place or retrieved from the cache. - + The -NoCache +NoCache method can be used to disable caching of specific files. This can be useful if inputs and/or outputs of some tool are impossible to predict or prohibitively large. @@ -726,14 +672,9 @@ predict or prohibitively large. - - Clean(targets, files_or_dirs) - - - env.Clean(targets, files_or_dirs) - - - + Clean(targets, files_or_dirs) + env.Clean(targets, files_or_dirs) + This specifies a list of files or directories which should be removed whenever the targets are specified with the @@ -741,28 +682,28 @@ command line option. The specified targets may be a list or an individual target. Multiple calls to -Clean +Clean are legal, and create new targets or add files and directories to the clean list for the specified targets. - + Multiple files or directories should be specified either as separate arguments to the -Clean +Clean method, or as a list. -Clean +Clean will also accept the return value of any of the construction environment Builder methods. Examples: - + The related -NoClean +NoClean function overrides calling -Clean +Clean for the same target, and any targets passed to both functions will not @@ -771,33 +712,30 @@ be removed by the option. - + Examples: - + Clean('foo', ['bar', 'baz']) Clean('dist', env.Program('hello', 'hello.c')) Clean(['foo', 'bar'], 'something_else_to_clean') - + In this example, installing the project creates a subdirectory for the documentation. This statement causes the subdirectory to be removed if the project is deinstalled. - + Clean(docdir, os.path.join(docdir, projectname)) - - env.Clone([key=val, ...]) - - - + env.Clone([key=val, ...]) + Returns a separate copy of a construction environment. If there are any keyword arguments specified, they are added to the returned copy, @@ -805,48 +743,43 @@ overwriting any existing values for the keywords. - + Example: - + env2 = env.Clone() env3 = env.Clone(CCFLAGS = '-g') - + Additionally, a list of tools and a toolpath may be specified, as in -the Environment constructor: +the Environment constructor: - + def MyTool(env): env['FOO'] = 'bar' env4 = env.Clone(tools = ['msvc', MyTool]) - + The parse_flags keyword argument is also recognized to allow merging command-line style arguments into the appropriate construction -variables (see env.MergeFlags). +variables (see env.MergeFlags). - + # create an environment for compiling programs that use wxWidgets wx_env = env.Clone(parse_flags='!wx-config --cflags --cxxflags') - - Command(target, source, action, [key=val, ...]) - - - env.Command(target, source, action, [key=val, ...]) - - - + Command(target, source, action, [key=val, ...]) + env.Command(target, source, action, [key=val, ...]) + Executes a specific action (or list of actions) to build a target file or files. @@ -855,8 +788,8 @@ than defining a separate Builder object for a single special-case build. - -Command builder accepts + +Command builder accepts source_scanner, target_scanner, source_factory, and @@ -881,12 +814,12 @@ below, for more information about how these args work in a Builder. - + Any other keyword arguments specified override any same-named existing construction variables. - + An action can be an external command, specified as a string, or a callable Python object; @@ -903,11 +836,11 @@ or by a to ignore the exit status of the external command. - + Examples: - + env.Command('foo.out', 'foo.in', "$FOO_BUILD < $SOURCES > $TARGET") @@ -925,9 +858,9 @@ env.Command('baz.out', 'baz.in', rename]) - + Note that the -Command +Command function will usually assume, by default, that the specified targets and/or sources are Files, if no other part of the configuration @@ -936,24 +869,24 @@ If necessary, you can explicitly specify that targets or source nodes should be treated as directories by using the -Dir +Dir or env.Dir functions. - + Examples: - + env.Command('ddd.list', Dir('ddd'), 'ls -l $SOURCE > $TARGET') env['DISTDIR'] = 'destination/directory' env.Command(env.Dir('$DISTDIR')), None, make_distdir) - + Also note that SCons will usually automatically create any directory necessary to hold a target file, so you normally don't need to create directories by hand. @@ -961,14 +894,9 @@ so you normally don't need to create directories by hand. - - Configure(env, [custom_tests, conf_dir, log_file, config_h]) - - - env.Configure([custom_tests, conf_dir, log_file, config_h]) - - - + Configure(env, [custom_tests, conf_dir, log_file, config_h]) + env.Configure([custom_tests, conf_dir, log_file, config_h]) + Creates a Configure object for integrated functionality similar to GNU autoconf. See the manpage section "Configure Contexts" @@ -977,25 +905,17 @@ for a complete explanation of the arguments and behavior. - - env.Copy([key=val, ...]) - - - + env.Copy([key=val, ...]) + A now-deprecated synonym for env.Clone(). - - Decider(function) - - - env.Decider(function) - - - + Decider(function) + env.Decider(function) + Specifies that all up-to-date decisions for targets built through this construction environment will be handled by the specified @@ -1007,7 +927,7 @@ that specify the type of decision function to be performed: - + timestamp-newer @@ -1090,11 +1010,11 @@ all within a single second. - + Examples: - + # Use exact timestamp matches by default. Decider('timestamp-match') @@ -1103,15 +1023,14 @@ Decider('timestamp-match') env.Decider('content') - -In addition to the above already-available functions, -the + +In addition to the above already-available functions, the function -argument may be an actual Python function -that takes the following three arguments: +argument may be a Python function you supply. +Such a function must accept the following four arguments: - + dependency @@ -1160,9 +1079,14 @@ size, or content signature. repo_node -Use this node instead of the one specified by +If set, use this Node instead of the one specified by dependency - to determine if the dependency has changed. +to determine if the dependency has changed. +This argument is optional so should be written +as a default argument (typically it would be +written as repo_node=None). +A caller will normally only set this if the +target only exists in a Repository. @@ -1170,13 +1094,12 @@ Use this node instead of the one specified by - + The function -should return a -True -(non-zero) -value if the +should return a value which evaluates +True +if the dependency has "changed" since the last time the @@ -1185,9 +1108,8 @@ was built (indicating that the target should be rebuilt), -and -False -(zero) +and a value which evaluates +False otherwise (indicating that the target should not @@ -1198,11 +1120,11 @@ Ignoring some or all of the function arguments is perfectly normal. - + Example: - + def my_decider(dependency, target, prev_ni, repo_node=None): return not os.path.exists(str(target)) @@ -1211,20 +1133,15 @@ env.Decider(my_decider) - - Default(targets) - - - env.Default(targets) - - - + Default(targets...) + env.Default(targets...) + This specifies a list of default targets, which will be built by -scons +scons if no explicit targets are given on the command line. Multiple calls to -Default +Default are legal, and add to the list of default targets. As noted above, both forms of this call affect the @@ -1233,43 +1150,43 @@ construction environment method applies construction variable expansion to the targets. - + Multiple targets should be specified as separate arguments to the -Default +Default method, or as a list. -Default +Default will also accept the Node returned by any of a construction environment's builder methods. - + Examples: - + Default('foo', 'bar', 'baz') env.Default(['a', 'b', 'c']) hello = env.Program('hello', 'hello.c') env.Default(hello) - + An argument to -Default +Default of None will clear all default targets. Later calls to -Default +Default will add to the (now empty) default-target list like normal. - + The current list of targets added using the -Default +Default function or method is available in the DEFAULT_TARGETS list; @@ -1278,34 +1195,29 @@ see below. - - DefaultEnvironment([**kwargs]) - - - -Creates and returns the default construction environment object. -The default construction environment is used internally by SCons + DefaultEnvironment([**kwargs]) + +Creates and returns the default construction environment object. +The default construction environment is used internally by SCons in order to execute many of the global functions in this list (i.e. those not called as methods of a specific -construction environment), and to fetch source files transparently +construction environment), and to fetch source files transparently from source code management systems. The default environment is a singleton, so the keyword arguments affect it only on the first call, on subsequent -calls the already-constructed object is returned. +calls the already-constructed object is returned and +any arguments are ignored. The default environment can be modified in the same way -as any construction environment. +as any construction environment. +Modifying the default environment has no effect on the environment +constructed by a subsequent Environment call. - - Depends(target, dependency) - - - env.Depends(target, dependency) - - - + Depends(target, dependency) + env.Depends(target, dependency) + Specifies an explicit dependency; the target @@ -1328,11 +1240,11 @@ is not caught by a Scanner for the file. - + Example: - + env.Depends('foo', 'other-input-file-for-foo') mylib = env.Library('mylib.c') @@ -1349,44 +1261,51 @@ env.Depends(bar, installed_lib) + + env.Detect(progs) + +Find an executable from one or more choices: +progs may be a string or a list of strings. +Returns the first value from progs +that was found, or None. +Executable is searched by checking the paths specified +by env['ENV']['PATH']. +On Windows systems, additionally applies the filename suffixes found in +env['ENV']['PATHEXT'] +but will not include any such extension in the return value. +env.Detect is a wrapper around env.WhereIs. + + + - - env.Dictionary([vars]) - - - + env.Dictionary([vars]) + Returns a dictionary object -containing the construction variables in the construction environment. +containing the construction variables in the construction environment. If there are any arguments specified, -the values of the specified construction variables +the values of the specified construction variables are returned as a string (if one argument) or as a list of strings. - + Example: - + cvars = env.Dictionary() cc_values = env.Dictionary('CC', 'CCFLAGS', 'CCCOM') - - Dir(name, [directory]) - - - env.Dir(name, [directory]) - - - -This returns a Directory Node, -an object that represents the specified directory -name. + Dir(name, [directory]) + env.Dir(name, [directory]) + +Returns Directory Node(s). +A Directory Node is an object that represents a directory. name -can be a relative or absolute path. +can be a relative or absolute path or a list of such paths. directory is an optional directory that will be used as the parent directory. If no @@ -1394,15 +1313,18 @@ If no is specified, the current script's directory is used as the parent. - + If name -is a list, SCons returns a list of Dir nodes. +is a single pathname, the corresponding node is returned. +If +name +is a list, SCons returns a list of nodes. Construction variables are expanded in name. - + Directory Nodes can be used anywhere you would supply a string as a directory name to a Builder method or function. @@ -1414,11 +1336,8 @@ for more information. - - env.Dump([key]) - - - + env.Dump([key]) + Returns a pretty printable representation of the environment. key, if not @@ -1426,36 +1345,36 @@ if not should be a string containing the name of the variable of interest. - + This SConstruct: - + env=Environment() print(env.Dump('CCCOM')) - + will print: - + '$CC -c -o $TARGET $CCFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS $SOURCES' - + While this SConstruct: - + env=Environment() print(env.Dump()) - + will print: - + { 'AR': 'ar', 'ARCOM': '$AR $ARFLAGS $TARGET $SOURCES\n$RANLIB $RANLIBFLAGS $TARGET', 'ARFLAGS': ['r'], @@ -1467,14 +1386,9 @@ will print: - - EnsurePythonVersion(major, minor) - - - env.EnsurePythonVersion(major, minor) - - - + EnsurePythonVersion(major, minor) + env.EnsurePythonVersion(major, minor) + Ensure that the Python version is at least major.minor. This function will @@ -1482,24 +1396,19 @@ print out an error message and exit SCons with a non-zero exit code if the actual Python version is not late enough. - + Example: - + EnsurePythonVersion(2,2) - - EnsureSConsVersion(major, minor, [revision]) - - - env.EnsureSConsVersion(major, minor, [revision]) - - - + EnsureSConsVersion(major, minor, [revision]) + env.EnsureSConsVersion(major, minor, [revision]) + Ensure that the SCons version is at least major.minor, or @@ -1512,11 +1421,11 @@ print out an error message and exit SCons with a non-zero exit code if the actual SCons version is not late enough. - + Examples: - + EnsureSConsVersion(0,14) EnsureSConsVersion(0,96,90) @@ -1524,14 +1433,9 @@ EnsureSConsVersion(0,96,90) - - Environment([key=value, ...]) - - - env.Environment([key=value, ...]) - - - + Environment([key=value, ...]) + env.Environment([key=value, ...]) + Return a new construction environment initialized with the specified key=value @@ -1540,14 +1444,9 @@ pairs. - - Execute(action, [strfunction, varlist]) - - - env.Execute(action, [strfunction, varlist]) - - - + Execute(action, [strfunction, varlist]) + env.Execute(action, [strfunction, varlist]) + Executes an Action object. The specified action @@ -1565,14 +1464,14 @@ or return value of the Python function will be returned. - + Note that -scons +scons will print an error message if the executed action fails--that is, exits with or returns a non-zero value. -scons +scons will not, however, @@ -1581,12 +1480,12 @@ if the specified action fails. If you want the build to stop in response to a failed -Execute +Execute call, you must explicitly check for a non-zero return value: - + Execute(Copy('file.out', 'file.in')) if Execute("mkdir sub/dir/ectory"): @@ -1596,16 +1495,11 @@ if Execute("mkdir sub/dir/ectory"): - - Exit([value]) - - - env.Exit([value]) - - - + Exit([value]) + env.Exit([value]) + This tells -scons +scons to exit immediately with the specified value. @@ -1617,35 +1511,33 @@ is used if no value is specified. - - Export(vars) - - - env.Export(vars) - - - -This tells -scons -to export a list of variables from the current -SConscript file to all other SConscript files. -The exported variables are kept in a global collection, -so subsequent calls to -Export -will over-write previous exports that have the same name. -Multiple variable names can be passed to -Export -as separate arguments or as a list. + Export([vars...], [key=value...]) + env.Export([vars...], [key=value...]) + +Exports variables from the current +SConscript file to a global collection where they can be +imported by other SConscript files. +vars may be one or more +strings representing variable names to be exported. +If a string contains whitespace, it is split into +separate strings, as if multiple string arguments +had been given. A vars argument +may also be a dictionary, which can be used to map variables +to different names when exported. Keyword arguments can be used to provide names and their values. -A dictionary can be used to map variables to a different name when exported. + + + +Export calls are cumulative. Specifying a previously +exported variable will overwrite the earlier value. Both local variables and global variables can be exported. - + Examples: - + env = Environment() # Make env available for all SConscript files to Import(). Export("env") @@ -1658,53 +1550,49 @@ Export("env", "package") Export(["env", "package"]) # Make env available using the name debug: -Export(debug = env) +Export(debug=env) # Make env available using the name debug: -Export({"debug":env}) +Export({"debug": env}) - + Note that the -SConscript -function supports an -exports -argument that makes it easier to to export a variable or -set of variables to a single SConscript file. -See the description of the -SConscript -function, below. +SConscript +function supports an exports +argument that allows exporting a variable or +set of variables to a specific SConscript file or files. +See the description below. - - File(name, [directory]) - - - env.File(name, [directory]) - - - -This returns a -File Node, -an object that represents the specified file -name. + File(name, [directory]) + env.File(name, [directory]) + +Returns File Node(s). +A File Node is an object that represents a file. name -can be a relative or absolute path. +can be a relative or absolute path or a list of such paths. directory is an optional directory that will be used as the parent directory. +If no +directory +is specified, the current script's directory is used as the parent. - + +If +name +is a single pathname, the corresponding node is returned. If name -is a list, SCons returns a list of File nodes. +is a list, SCons returns a list of nodes. Construction variables are expanded in name. - + File Nodes can be used anywhere you would supply a string as a file name to a Builder method or function. @@ -1716,14 +1604,9 @@ for more information. - - FindFile(file, dirs) - - - env.FindFile(file, dirs) - - - + FindFile(file, dirs) + env.FindFile(file, dirs) + Search for file in the path specified by @@ -1735,41 +1618,36 @@ this function also searches for derived files that have not yet been built. - + Example: - + foo = env.FindFile('foo', ['dir1', 'dir2']) - - FindInstalledFiles() - - - env.FindInstalledFiles() - - - + FindInstalledFiles() + env.FindInstalledFiles() + Returns the list of targets set up by the -Install +Install or -InstallAs +InstallAs builders. - + This function serves as a convenient method to select the contents of a binary package. - + Example: - + Install( '/bin', [ 'executable_a', 'executable_b' ] ) # will return the file node list @@ -1785,11 +1663,8 @@ FindInstalledFiles() - - FindPathDirs(variable) - - - + FindPathDirs(variable) + Returns a function (actually a callable Python object) intended to be used as the @@ -1801,14 +1676,14 @@ in a construction environment and treat the construction variable's value as a list of directory paths that should be searched (like -$CPPPATH, -$LIBPATH, +$CPPPATH, +$LIBPATH, etc.). - + Note that use of -FindPathDirs +FindPathDirs is generally preferable to writing your own path_function @@ -1816,11 +1691,11 @@ for the following reasons: 1) The returned list will contain all appropriate directories found in source trees (when -VariantDir +VariantDir is used) or in code repositories (when -Repository +Repository or the option are used). @@ -1832,11 +1707,11 @@ and avoid re-scanning the directories for files, when possible. - + Example: - + def my_scan(node, env, path, arg): # Code to scan file contents goes here... return include_files @@ -1848,14 +1723,9 @@ scanner = Scanner(name = 'myscanner', - - FindSourceFiles(node='"."') - - - env.FindSourceFiles(node='"."') - - - + FindSourceFiles(node='"."') + env.FindSourceFiles(node='"."') + Returns the list of nodes which serve as the source of the built files. It does so by inspecting the dependency tree starting at the optional argument @@ -1865,16 +1735,16 @@ which defaults to the '"."'-node. It will then return all leaves of These are all children which have no further children. - + This function is a convenient method to select the contents of a Source Package. - + Example: - + Program( 'src/main_a.c' ) Program( 'src/main_b.c' ) Program( 'main_c.c' ) @@ -1886,21 +1756,16 @@ FindSourceFiles() FindSourceFiles( 'src' ) - + As you can see build support files (SConstruct in the above example) will also be returned by this function. - - Flatten(sequence) - - - env.Flatten(sequence) - - - + Flatten(sequence) + env.Flatten(sequence) + Takes a sequence (that is, a Python list or tuple) that may contain nested sequences and returns a flattened list containing @@ -1913,11 +1778,11 @@ but direct Python manipulation of these lists does not. - + Examples: - + foo = Object('foo.c') bar = Object('bar.c') @@ -1937,11 +1802,8 @@ for object in Flatten(objects): - - GetBuildFailures() - - - + GetBuildFailures() + Returns a list of exceptions for the actions that failed while attempting to build targets. @@ -1953,13 +1815,13 @@ that record various aspects of the build failure: - + .node The node that was being built when the build failure occurred. - + .status The numeric exit status returned by the command or Python function @@ -1967,7 +1829,7 @@ that failed when trying to build the specified Node. - + .errstr The SCons error string describing the build failure. @@ -1977,7 +1839,7 @@ to indicate that an executed command exited with a status of 2.) - + .filename The name of the file or directory that actually caused the failure. @@ -2000,7 +1862,7 @@ attribute will be sub/dir. - + .executor The SCons Executor object for the target Node @@ -2010,7 +1872,7 @@ the construction environment used for the failed action. - + .action The actual SCons Action object that failed. This will be one specific action @@ -2019,26 +1881,26 @@ actions that would have been executed to build the target. - + .command The actual expanded command that was executed and failed, after expansion of -$TARGET, -$SOURCE, +$TARGET, +$SOURCE, and other construction variables. - + Note that the -GetBuildFailures +GetBuildFailures function will always return an empty list until any build failure has occurred, which means that -GetBuildFailures +GetBuildFailures will always return an empty list while the -SConscript +SConscript files are being read. Its primary intended use is for functions that will be @@ -2050,7 +1912,7 @@ function. Example: - + import atexit def print_build_failures(): @@ -2063,16 +1925,11 @@ atexit.register(print_build_failures) - - GetBuildPath(file, [...]) - - - env.GetBuildPath(file, [...]) - - - + GetBuildPath(file, [...]) + env.GetBuildPath(file, [...]) + Returns the -scons +scons path name (or names) for the specified file (or files). @@ -2080,22 +1937,17 @@ The specified file or files may be -scons +scons Nodes or strings representing path names. - - GetLaunchDir() - - - env.GetLaunchDir() - - - + GetLaunchDir() + env.GetLaunchDir() + Returns the absolute path name of the directory from which -scons +scons was initially invoked. This can be useful when using the , @@ -2104,35 +1956,30 @@ or options, which internally change to the directory in which the -SConstruct +SConstruct file is found. - - GetOption(name) - - - env.GetOption(name) - - - + GetOption(name) + env.GetOption(name) + This function provides a way to query the value of SCons options set on scons command line (or set using the -SetOption +SetOption function). The options supported are: - + cache_debug -which corresponds to --cache-debug; +which corresponds to ; @@ -2140,7 +1987,7 @@ which corresponds to --cache-debug; cache_disable -which corresponds to --cache-disable; +which corresponds to ; @@ -2148,7 +1995,7 @@ which corresponds to --cache-disable; cache_force -which corresponds to --cache-force; +which corresponds to ; @@ -2156,7 +2003,7 @@ which corresponds to --cache-force; cache_show -which corresponds to --cache-show; +which corresponds to ; @@ -2164,7 +2011,8 @@ which corresponds to --cache-show; clean -which corresponds to -c, --clean and --remove; +which corresponds to , +and ; @@ -2172,7 +2020,7 @@ which corresponds to -c, --clean and --remove; config -which corresponds to --config; +which corresponds to ; @@ -2180,7 +2028,7 @@ which corresponds to --config; directory -which corresponds to -C and --directory; +which corresponds to and ; @@ -2188,7 +2036,7 @@ which corresponds to -C and --directory; diskcheck -which corresponds to --diskcheck +which corresponds to ; @@ -2196,7 +2044,7 @@ which corresponds to --diskcheck duplicate -which corresponds to --duplicate; +which corresponds to ; @@ -2204,7 +2052,7 @@ which corresponds to --duplicate; file -which corresponds to -f, --file, --makefile and --sconstruct; +which corresponds to , , and ; @@ -2212,7 +2060,7 @@ which corresponds to -f, --file, --makefile and --sconstruct; help -which corresponds to -h and --help; +which corresponds to and ; @@ -2220,7 +2068,7 @@ which corresponds to -h and --help; ignore_errors -which corresponds to --ignore-errors; +which corresponds to ; @@ -2228,7 +2076,7 @@ which corresponds to --ignore-errors; implicit_cache -which corresponds to --implicit-cache; +which corresponds to ; @@ -2236,7 +2084,7 @@ which corresponds to --implicit-cache; implicit_deps_changed -which corresponds to --implicit-deps-changed; +which corresponds to ; @@ -2244,7 +2092,7 @@ which corresponds to --implicit-deps-changed; implicit_deps_unchanged -which corresponds to --implicit-deps-unchanged; +which corresponds to ; @@ -2252,7 +2100,7 @@ which corresponds to --implicit-deps-unchanged; interactive -which corresponds to --interact and --interactive; +which corresponds to and ; @@ -2260,7 +2108,7 @@ which corresponds to --interact and --interactive; keep_going -which corresponds to -k and --keep-going; +which corresponds to and ; @@ -2268,7 +2116,7 @@ which corresponds to -k and --keep-going; max_drift -which corresponds to --max-drift; +which corresponds to ; @@ -2276,7 +2124,9 @@ which corresponds to --max-drift; no_exec -which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; +which corresponds to , +, , + and ; @@ -2284,7 +2134,7 @@ which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; no_site_dir -which corresponds to --no-site-dir; +which corresponds to ; @@ -2292,7 +2142,7 @@ which corresponds to --no-site-dir; num_jobs -which corresponds to -j and --jobs; +which corresponds to and ; @@ -2300,7 +2150,7 @@ which corresponds to -j and --jobs; profile_file -which corresponds to --profile; +which corresponds to ; @@ -2308,7 +2158,7 @@ which corresponds to --profile; question -which corresponds to -q and --question; +which corresponds to and ; @@ -2316,7 +2166,7 @@ which corresponds to -q and --question; random -which corresponds to --random; +which corresponds to ; @@ -2324,7 +2174,7 @@ which corresponds to --random; repository -which corresponds to -Y, --repository and --srcdir; +which corresponds to , and ; @@ -2332,7 +2182,7 @@ which corresponds to -Y, --repository and --srcdir; silent -which corresponds to -s, --silent and --quiet; +which corresponds to , and ; @@ -2340,7 +2190,7 @@ which corresponds to -s, --silent and --quiet; site_dir -which corresponds to --site-dir; +which corresponds to ; @@ -2348,7 +2198,7 @@ which corresponds to --site-dir; stack_size -which corresponds to --stack-size; +which corresponds to ; @@ -2356,7 +2206,7 @@ which corresponds to --stack-size; taskmastertrace_file -which corresponds to --taskmastertrace; and +which corresponds to ; and @@ -2364,33 +2214,28 @@ which corresponds to --taskmastertrace; and warn -which corresponds to --warn and --warning. +which corresponds to and . - + See the documentation for the -corresponding command line object for information about each specific +corresponding command line option for information about each specific option. - - Glob(pattern, [ondisk, source, strings, exclude]) - - - env.Glob(pattern, [ondisk, source, strings, exclude]) - - - + Glob(pattern, [ondisk, source, strings, exclude]) + env.Glob(pattern, [ondisk, source, strings, exclude]) + Returns Nodes (or strings) that match the specified pattern, relative to the directory of the current -SConscript +SConscript file. The env.Glob() @@ -2400,20 +2245,20 @@ and returns whatever matches the resulting expanded pattern. - + The specified pattern uses Unix shell style metacharacters for matching: - + * matches everything ? matches any single character [seq] matches any character in seq [!seq] matches any char not in seq - + If the first character of a filename is a dot, it must be matched explicitly. Character matches do @@ -2421,17 +2266,17 @@ Character matches do span directory separators. - + The -Glob +Glob knows about repositories (see the -Repository +Repository function) and source directories (see the -VariantDir +VariantDir function) and returns a Node (or string, if so configured) @@ -2441,12 +2286,11 @@ anywhere in a corresponding repository or source directory. - + The ondisk -argument may be set to -False -(or any other non-true value) +argument may be set to a value which evaluates +False to disable the search for matches on disk, thereby only returning matches among already-configured File or Dir Nodes. @@ -2455,28 +2299,26 @@ return corresponding Nodes for any on-disk matches found. - + The source -argument may be set to -True -(or any equivalent value) +argument may be set to a value which evaluates +True to specify that, when the local directory is a -VariantDir, +VariantDir, the returned Nodes should be from the corresponding source directory, not the local directory. - + The strings -argument may be set to -True -(or any equivalent value) +argument may be set to a value which evaluates +True to have the -Glob +Glob function return strings, not Nodes, that represent the matched files or directories. The returned strings will be relative to @@ -2485,18 +2327,18 @@ the local (SConscript) directory. arbitrary manipulation of file names, but if the returned strings are passed to a different -SConscript +SConscript file, any Node translation will be relative to the other -SConscript +SConscript directory, not the original -SConscript +SConscript directory.) - + The exclude argument may be set to a pattern or a list of patterns @@ -2506,80 +2348,71 @@ Elements matching a least one pattern of this list will be excluded. - + Examples: - -Program('foo', Glob('*.c')) -Zip('/tmp/everything', Glob('.??*') + Glob('*')) -sources = Glob('*.cpp', exclude=['os_*_specific_*.cpp']) + Glob('os_%s_specific_*.cpp'%currentOS) + +Program("foo", Glob("*.c")) +Zip("/tmp/everything", Glob(".??*") + Glob("*")) +sources = Glob("*.cpp", exclude=["os_*_specific_*.cpp"]) + \ + Glob( "os_%s_specific_*.cpp" % currentOS) - - Help(text, append=False) - - - env.Help(text, append=False) - - - + Help(text, append=False) + env.Help(text, append=False) + This specifies help text to be printed if the argument is given to -scons. -If -Help -is called multiple times, the text is appended together in the order that -Help -is called. With append set to False, any -Help -text generated with -AddOption +scons. +If +Help +is called multiple times, the text is appended together in the order that +Help +is called. With append set to False, any +Help +text generated with +AddOption is clobbered. If append is True, the AddOption help is prepended to the help -string, thus preserving the +string, thus preserving the message. - - Ignore(target, dependency) - - - env.Ignore(target, dependency) - - - + Ignore(target, dependency) + env.Ignore(target, dependency) + The specified dependency file(s) will be ignored when deciding if the target file(s) need to be rebuilt. - + You can also use -Ignore +Ignore to remove a target from the default build. In order to do this you must specify the directory the target will be built in as the target, and the file you want to skip building as the dependency. - + Note that this will only remove the dependencies listed from the files built by default. It will still be built if that dependency is needed by another object being built. See the third and forth examples below. - + Examples: - + env.Ignore('foo', 'foo.c') env.Ignore('bar', ['bar1.h', 'bar2.h']) env.Ignore('.','foobar.obj') @@ -2588,37 +2421,31 @@ env.Ignore('bar','bar/foobar.obj') - - Import(vars) - - - env.Import(vars) - - - -This tells -scons -to import a list of variables into the current SConscript file. This -will import variables that were exported with -Export -or in the -exports -argument to -SConscript. + Import(vars...) + env.Import(vars...) + +Imports variables into the current SConscript file. +vars +must be strings representing names of variables +which have been previously exported either by the +Export function or by the +exports argument to +SConscript. Variables exported by -SConscript -have precedence. +SConscript +take precedence. Multiple variable names can be passed to -Import -as separate arguments or as a list. The variable "*" can be used -to import all variables. +Import +as separate arguments or as words in a space-separated string. +The wildcard "*" can be used to import all +available variables. - + Examples: - + Import("env") Import("env", "variable") Import(["env", "variable"]) @@ -2627,14 +2454,9 @@ Import("*") - - Literal(string) - - - env.Literal(string) - - - + Literal(string) + env.Literal(string) + The specified string will be preserved as-is @@ -2643,14 +2465,9 @@ and not have construction variables expanded. - - Local(targets) - - - env.Local(targets) - - - + Local(targets) + env.Local(targets) + The specified targets will have copies made in the local tree, @@ -2661,11 +2478,8 @@ Returns a list of the target Node or Nodes. - - env.MergeFlags(arg, [unique]) - - - + env.MergeFlags(arg, [unique]) + Merges the specified arg values to the construction environment's construction variables. @@ -2673,7 +2487,7 @@ If the arg argument is not a dictionary, it is converted to one by calling -env.ParseFlags +env.ParseFlags on the argument before the values are merged. Note that @@ -2682,10 +2496,10 @@ must be a single value, so multiple strings must be passed in as a list, not as separate arguments to -env.MergeFlags. +env.MergeFlags. - + By default, duplicate values are eliminated; you can, however, specify @@ -2701,11 +2515,11 @@ All other construction variables keep the right-most unique value. - + Examples: - + # Add an optimization flag to $CCFLAGS. env.MergeFlags('-O3') @@ -2722,59 +2536,49 @@ env.MergeFlags(['-O3', - - NoCache(target, ...) - - - env.NoCache(target, ...) - - - + NoCache(target, ...) + env.NoCache(target, ...) + Specifies a list of files which should not be cached whenever the -CacheDir +CacheDir method has been activated. The specified targets may be a list or an individual target. - + Multiple files should be specified either as separate arguments to the -NoCache +NoCache method, or as a list. -NoCache +NoCache will also accept the return value of any of the construction environment Builder methods. - + Calling -NoCache +NoCache on directories and other non-File Node types has no effect because only File Nodes are cached. - + Examples: - + NoCache('foo.elf') NoCache(env.Program('hello', 'hello.c')) - - NoClean(target, ...) - - - env.NoClean(target, ...) - - - + NoClean(target, ...) + env.NoClean(target, ...) + Specifies a list of files or directories which should not be removed whenever the targets (or their dependencies) @@ -2784,7 +2588,7 @@ command line option. The specified targets may be a list or an individual target. Multiple calls to -NoClean +NoClean are legal, and prevent each specified target from being removed by calls to the @@ -2792,21 +2596,21 @@ from being removed by calls to the option. - + Multiple files or directories should be specified either as separate arguments to the -NoClean +NoClean method, or as a list. -NoClean +NoClean will also accept the return value of any of the construction environment Builder methods. - + Calling -NoClean +NoClean for a target overrides calling -Clean +Clean for the same target, and any targets passed to both functions will not @@ -2815,22 +2619,19 @@ be removed by the option. - + Examples: - + NoClean('foo.elf') NoClean(env.Program('hello', 'hello.c')) - - env.ParseConfig(command, [function, unique]) - - - + env.ParseConfig(command, [function, unique]) + Calls the specified function to modify the environment as specified by the output of @@ -2838,7 +2639,7 @@ to modify the environment as specified by the output of The default function is -env.MergeFlags, +env.MergeFlags, which expects the output of a typical *-config command @@ -2855,11 +2656,11 @@ to allow duplicate values to be added. - + Interpreted options and the construction variables they affect are as specified for the -env.ParseFlags +env.ParseFlags method (which this method calls). See that method's description for a table of options and construction variables. @@ -2867,24 +2668,19 @@ for a table of options and construction variables. - - ParseDepends(filename, [must_exist, only_one]) - - - env.ParseDepends(filename, [must_exist, only_one]) - - - + ParseDepends(filename, [must_exist, only_one]) + env.ParseDepends(filename, [must_exist, only_one]) + Parses the contents of the specified filename as a list of dependencies in the style of -Make +Make or mkdep, and explicitly establishes all of the listed dependencies. - + By default, it is not an error if the specified @@ -2900,7 +2696,7 @@ generate an error if the file does not exist, or is otherwise inaccessible. - + The optional only_one argument may be set to a non-zero @@ -2922,43 +2718,40 @@ one output file into a corresponding file. - + The filename and all of the files listed therein will be interpreted relative to the directory of the -SConscript +SConscript file which calls the -ParseDepends +ParseDepends function. - - env.ParseFlags(flags, ...) - - - + env.ParseFlags(flags, ...) + Parses one or more strings containing typical command-line flags for GCC tool chains and returns a dictionary with the flag values separated into the appropriate SCons construction variables. This is intended as a companion to the -env.MergeFlags +env.MergeFlags method, but allows for the values in the returned dictionary to be modified, if necessary, before merging them into the construction environment. (Note that -env.MergeFlags +env.MergeFlags will call this method if its argument is not a dictionary, so it is usually not necessary to call -env.ParseFlags +env.ParseFlags directly unless you want to manipulate the values.) - + If the first character in any string is an exclamation mark (!), the rest of the string is executed as a command, @@ -2967,12 +2760,12 @@ parsed as GCC tool chain command-line flags and added to the resulting dictionary. - + Flag values are translated accordig to the prefix found, and added to the following construction variables: - + -arch CCFLAGS, LINKFLAGS -D CPPDEFINES -framework FRAMEWORKS @@ -3003,19 +2796,19 @@ and added to the following construction variables: + CCFLAGS, LINKFLAGS - + Any other strings not associated with options are assumed to be the names of libraries and added to the -$LIBS +$LIBS construction variable. - + Examples (all of which produce the same result): - + dict = env.ParseFlags('-O2 -Dfoo -Dbar=1') dict = env.ParseFlags('-O2', '-Dfoo', '-Dbar=1') dict = env.ParseFlags(['-O2', '-Dfoo -Dbar=1']) @@ -3024,42 +2817,39 @@ dict = env.ParseFlags('-O2', '!echo -Dfoo -Dbar=1') - - Platform(string) - - - + Platform(string) + The -Platform +Platform form returns a callable object that can be used to initialize a construction environment using the platform keyword of the -Environment +Environment function. - + Example: - + env = Environment(platform = Platform('win32')) - + The -env.Platform +env.Platform form applies the callable object for the specified platform string to the environment through which the method was called. - + env.Platform('posix') - + Note that the win32 platform adds the @@ -3068,7 +2858,7 @@ and SystemRoot variables from the user's external environment to the construction environment's -$ENV +$ENV dictionary. This is so that any executed commands that use sockets to connect with other systems @@ -3080,30 +2870,22 @@ will work on Windows systems. - - Precious(target, ...) - - - env.Precious(target, ...) - - - + Precious(target, ...) + env.Precious(target, ...) + Marks each given target as precious so it is not deleted before it is rebuilt. Normally -scons +scons deletes a target before building it. Multiple targets can be passed in to a single call to -Precious. +Precious. - - env.Prepend(key=val, [...]) - - - + env.Prepend(key=val, [...]) + Appends the specified keyword arguments to the beginning of construction variables in the environment. If the Environment does not have @@ -3119,24 +2901,21 @@ and the lists are added together. (See also the Append method, above.) - + Example: - + env.Prepend(CCFLAGS = '-g ', FOO = ['foo.yyy']) - - env.PrependENVPath(name, newpath, [envname, sep, delete_existing]) - - - + env.PrependENVPath(name, newpath, [envname, sep, delete_existing]) + This appends new path elements to the given path in the specified external environment -($ENV +($ENV by default). This will only add any particular path once (leaving the first one it encounters and @@ -3151,7 +2930,7 @@ case where the given old path variable is a list instead of a string, in which case a list will be returned instead of a string. - + If delete_existing is 0, then adding a path that already exists @@ -3159,33 +2938,30 @@ will not move it to the beginning; it will stay where it is in the list. - + Example: - + print 'before:',env['ENV']['INCLUDE'] include_path = '/foo/bar:/foo' env.PrependENVPath('INCLUDE', include_path) print 'after:',env['ENV']['INCLUDE'] - + The above example will print: - + before: /biz:/foo after: /foo/bar:/foo:/biz - - env.PrependUnique(key=val, delete_existing=0, [...]) - - - + env.PrependUnique(key=val, delete_existing=0, [...]) + Appends the specified keyword arguments to the beginning of construction variables in the environment. If the Environment does not have @@ -3201,33 +2977,26 @@ existing matching values are removed first, so existing values in the arg list move to the front of the list. - + Example: - + env.PrependUnique(CCFLAGS = '-g', FOO = ['foo.yyy']) - - Progress(callable, [interval]) - - - Progress(string, [interval, file, overwrite]) - - - Progress(list_of_strings, [interval, file, overwrite]) - - - + Progress(callable, [interval]) + Progress(string, [interval, file, overwrite]) + Progress(list_of_strings, [interval, file, overwrite]) + Allows SCons to show progress made during the build by displaying a string or calling a function while evaluating Nodes (e.g. files). - + If the first specified argument is a Python callable (a function or an object that has a __call__() @@ -3249,19 +3018,19 @@ if SCons ever changes the interface to call the function with additional arguments in the future.) - + An example of a simple custom progress function that prints a string containing the Node name every 10 Nodes: - + def my_progress_function(node, *args, **kw): print('Evaluating node %s!' % node) Progress(my_progress_function, interval=10) - + A more complicated example of a custom progress display object that prints a string containing a count every 100 evaluated Nodes. @@ -3272,7 +3041,7 @@ at the end so that the string will overwrite itself on a display: - + import sys class ProgressCounter(object): count = 0 @@ -3282,9 +3051,9 @@ class ProgressCounter(object): Progress(ProgressCounter(), interval=100) - + If the first argument -Progress +Progress is a string, the string will be displayed every @@ -3300,14 +3069,14 @@ on the error output, one dot for every 100 evaluated Nodes: - + import sys Progress('.', interval=100, file=sys.stderr) - + If the string contains the verbatim substring -$TARGET, +$TARGET, it will be replaced with the Node. Note that, for performance reasons, this is not @@ -3325,14 +3094,14 @@ keyword argument to make sure the previously-printed file name is overwritten with blank spaces: - + import sys Progress('$TARGET\r', overwrite=True) - + If the first argument to -Progress +Progress is a list of strings, then each string in the list will be displayed in rotating fashion every @@ -3342,42 +3111,32 @@ This can be used to implement a "spinner" on the user's screen as follows: - + Progress(['-\r', '\\\r', '|\r', '/\r'], interval=5) - - Pseudo(target, ...) - - - env.Pseudo(target, ...) - - - + Pseudo(target, ...) + env.Pseudo(target, ...) + This indicates that each given target should not be created by the build rule, and if the target is created, an error will be generated. This is similar to the gnu make .PHONY target. However, in the vast majority of cases, an -Alias +Alias is more appropriate. Multiple targets can be passed in to a single call to -Pseudo. +Pseudo. - - PyPackageDir(modulename) - - - env.PyPackageDir(modulename) - - - + PyPackageDir(modulename) + env.PyPackageDir(modulename) + This returns a Directory Node similar to Dir. The python module / package is looked up and if located the directory is returned for the location. @@ -3385,7 +3144,7 @@ the directory is returned for the location. Is a named python package / module to lookup the directory for it's location. - + If modulename is a list, SCons returns a list of Dir nodes. @@ -3395,46 +3154,38 @@ Construction variables are expanded in - - env.Replace(key=val, [...]) - - - + env.Replace(key=val, [...]) + Replaces construction variables in the Environment with the specified keyword arguments. - + Example: - + env.Replace(CCFLAGS = '-g', FOO = 'foo.xxx') - - Repository(directory) - - - env.Repository(directory) - - - + Repository(directory) + env.Repository(directory) + Specifies that directory is a repository to be searched for files. Multiple calls to -Repository +Repository are legal, and each one adds to the list of repositories that will be searched. - + To -scons, +scons, a repository is a copy of the source tree, from the top-level directory on down, which may contain @@ -3445,39 +3196,34 @@ The canonical example would be an official source tree maintained by an integrator. If the repository contains derived files, then the derived files should have been built using -scons, +scons, so that the repository contains the necessary signature information to allow -scons +scons to figure out when it is appropriate to use the repository copy of a derived file, instead of building one locally. - + Note that if an up-to-date derived file already exists in a repository, -scons +scons will not make a copy in the local directory tree. In order to guarantee that a local copy will be made, use the -Local +Local method. - - Requires(target, prerequisite) - - - env.Requires(target, prerequisite) - - - + Requires(target, prerequisite) + env.Requires(target, prerequisite) + Specifies an order-only relationship between the specified target file(s) and the specified prerequisite file(s). @@ -3491,55 +3237,55 @@ and will not be rebuilt simply because the prerequisite file(s) change. - + Example: - + env.Requires('foo', 'file-that-must-be-built-before-foo') - - Return([vars..., stop=]) - - - -By default, -this stops processing the current SConscript -file and returns to the calling SConscript file -the values of the variables named in the -vars -string arguments. + Return([vars..., stop=True]) + +Return to the calling SConscript, optionally +returning the values of variables named in +vars. Multiple strings contaning variable names may be passed to -Return. -Any strings that contain white space +Return. A string containing white space +is split into individual variable names. +Returns the value if one variable is specified, +else returns a tuple of values. +Returns an empty tuple if vars +is omitted. - + +By default Return stops processing the current SConscript +and returns immediately. The optional -stop= -keyword argument may be set to a false value +stop +keyword argument +may be set to a false value to continue processing the rest of the SConscript file after the -Return -call. -This was the default behavior prior to SCons 0.98. +Return +call (this was the default behavior prior to SCons 0.98.) However, the values returned are still the values of the variables in the named vars at the point -Return -is called. +Return +was called. - + Examples: - -# Returns without returning a value. + +# Returns no values (evaluates False) Return() # Returns the value of the 'foo' Python variable. @@ -3554,14 +3300,9 @@ Return('val1 val2') - - Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive]) - - - env.Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive]) - - - + Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive]) + env.Scanner(function, [argument, keys, path_function, node_class, node_factory, scan_check, recursive]) + Creates a Scanner object for the specified function. @@ -3571,36 +3312,18 @@ for a complete explanation of the arguments and behavior. - - SConscript(scripts, [exports, variant_dir, duplicate, must_exist]) - - - env.SConscript(scripts, [exports, variant_dir, duplicate, must_exist]) - - - SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist]) - - - env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist]) - - - -This tells -scons -to execute -one or more subsidiary SConscript (configuration) files. -Any variables returned by a called script using -Return -will be returned by the call to -SConscript. + SConscript(scripts, [exports, variant_dir, duplicate, must_exist]) + env.SConscript(scripts, [exports, variant_dir, duplicate, must_exist]) + SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist]) + env.SConscript(dirs=subdirs, [name=script, exports, variant_dir, duplicate, must_exist]) + +Execute one or more subsidiary SConscript (configuration) files. There are two ways to call the -SConscript -function. +SConscript function. - -The first way you can call -SConscript + +The first calling style is to explicitly specify one or more scripts as the first argument. @@ -3608,148 +3331,131 @@ A single script may be specified as a string; multiple scripts must be specified as a list (either explicitly or as created by a function like -Split). +Split). Examples: - + SConscript('SConscript') # run SConscript in the current directory SConscript('src/SConscript') # run SConscript in the src directory SConscript(['src/SConscript', 'doc/SConscript']) config = SConscript('MyConfig.py') - -The second way you can call -SConscript + +The second way to call +SConscript is to specify a list of (sub)directory names as a -dirs=subdirs +dirs=subdirs keyword argument. In this case, -scons -will, by default, +scons +will execute a subsidiary configuration file named -SConscript +SConscript in each of the specified directories. You may specify a name other than -SConscript +SConscript by supplying an optional -name=script +name=script keyword argument. The first three examples below have the same effect as the first three examples above: - + SConscript(dirs='.') # run SConscript in the current directory SConscript(dirs='src') # run SConscript in the src directory SConscript(dirs=['src', 'doc']) SConscript(dirs=['sub1', 'sub2'], name='MySConscript') - + The optional exports -argument provides a list of variable names or a dictionary of -named values to export to the -script(s). -These variables are locally exported only to the specified -script(s), -and do not affect the global pool of variables used by the -Export +argument provides a string or list of strings representing +variable names, or a dictionary of named values, to export. +These variables are locally exported only to the called +SConscript file(s) +and do not affect the global pool of variables managed by the +Export function. -The subsidiary -script(s) +The subsidiary SConscript files must use the -Import +Import function to import the variables. Examples: - + foo = SConscript('sub/SConscript', exports='env') SConscript('dir/SConscript', exports=['env', 'variable']) SConscript(dirs='subdir', exports='env variable') SConscript(dirs=['one', 'two', 'three'], exports='shared_info') - + If the optional variant_dir argument is present, it causes an effect equivalent to the -VariantDir -method described below. -(If -variant_dir -is not present, the - -duplicate - -argument is ignored.) -The -variant_dir - +VariantDir function. +The variant_dir argument is interpreted relative to the directory of the calling -SConscript -file. -See the description of the -VariantDir -function below for additional details and restrictions. +SConscript file. +The optional +duplicate argument is +interpreted as for VariantDir. +If variant_dir +is omitted, the duplicate argument is ignored. +See the description of +VariantDir +below for additional details and restrictions. - + If variant_dir is present, - the source directory is the directory in which the -SConscript +SConscript file resides and the -SConscript +SConscript file is evaluated as if it were in the variant_dir directory: - -SConscript('src/SConscript', variant_dir = 'build') + +SConscript('src/SConscript', variant_dir='build') - + is equivalent to - + VariantDir('build', 'src') SConscript('build/SConscript') - + This later paradigm is often used when the sources are in the same directory as the -SConstruct: +SConstruct: - -SConscript('SConscript', variant_dir = 'build') + +SConscript('SConscript', variant_dir='build') - + is equivalent to - + VariantDir('build', '.') SConscript('build/SConscript') - + - -The optional + +If the optional must_exist -argument, if true, causes an exception to be raised if a requested -SConscript file is not found. The current default is false, -causing only a warning to be omitted, but this behavior is deprecated. +is True, +causes an exception to be raised if a requested +SConscript file is not found. The current default is +False, +causing only a warning to be emitted, but this default is deprecated +(since 3.1). For scripts which truly intend to be optional, transition to -explicty supplying -must_exist=False to the call. +explicitly supplying +must_exist=False to the SConscript call. - + Here are some composite examples: - + # collect the configuration information and use it to build src and doc shared_info = SConscript('MyConfig.py') SConscript('src/SConscript', exports='shared_info') SConscript('doc/SConscript', exports='shared_info') - + # build debugging and production versions. SConscript # can use Dir('.').path to determine variant. SConscript('SConscript', variant_dir='debug', duplicate=0) SConscript('SConscript', variant_dir='prod', duplicate=0) - + # build debugging and production versions. SConscript # is passed flags to use. opts = { 'CPPDEFINES' : ['DEBUG'], 'CCFLAGS' : '-pgdb' } @@ -3820,25 +3529,32 @@ opts = { 'CPPDEFINES' : ['NODEBUG'], 'CCFLAGS' : '-O' } SConscript('SConscript', variant_dir='prod', duplicate=0, exports=opts) - + # build common documentation and compile for different architectures SConscript('doc/SConscript', variant_dir='build/doc', duplicate=0) SConscript('src/SConscript', variant_dir='build/x86', duplicate=0) SConscript('src/SConscript', variant_dir='build/ppc', duplicate=0) + + +SConscript returns the values of any variables +named by the executed SConscript(s) in arguments +to the Return function (see above for details). +If a single SConscript call causes multiple scripts to +be executed, the return value is a tuple containing +the returns of all of the scripts. If an executed +script does not explicitly call Return, it returns +None. + + - - SConscriptChdir(value) - - - env.SConscriptChdir(value) - - - + SConscriptChdir(value) + env.SConscriptChdir(value) + By default, -scons +scons changes its working directory to the directory in which each subsidiary SConscript file lives. @@ -3846,14 +3562,14 @@ This behavior may be disabled by specifying either: - + SConscriptChdir(0) env.SConscriptChdir(0) - + in which case -scons +scons will stay in the top-level directory while reading all SConscript files. (This may be necessary when building from repositories, @@ -3865,11 +3581,11 @@ SConscriptChdir() multiple times. - + Example: - + env = Environment() SConscriptChdir(0) SConscript('foo/SConscript') # will not chdir to foo @@ -3879,16 +3595,11 @@ SConscript('bar/SConscript') # will chdir to bar - - SConsignFile([file, dbm_module]) - - - env.SConsignFile([file, dbm_module]) - - - + SConsignFile([file, dbm_module]) + env.SConsignFile([file, dbm_module]) + This tells -scons +scons to store all file signatures in the specified database file. @@ -3905,17 +3616,17 @@ If file is not an absolute path name, the file is placed in the same directory as the top-level -SConstruct +SConstruct file. - + If file is None, then -scons +scons will store file signatures in a separate .sconsign @@ -3925,7 +3636,7 @@ not in one global database file. prior to SCons 0.96.91 and 0.97.) - + The optional dbm_module argument can be used to specify @@ -3937,11 +3648,11 @@ Python data structures, and which works on all Python versions. - + Examples: - + # Explicitly stores signatures in ".sconsign.dblite" # in the top-level SConstruct directory (the # default behavior). @@ -3961,17 +3672,14 @@ SConsignFile(None) - - env.SetDefault(key=val, [...]) - - - + env.SetDefault(key=val, [...]) + Sets construction variables to default values specified with the keyword arguments if (and only if) the variables are not already set. The following statements are equivalent: - + env.SetDefault(FOO = 'foo') if 'FOO' not in env: env['FOO'] = 'foo' @@ -3979,25 +3687,21 @@ if 'FOO' not in env: env['FOO'] = 'foo' - - SetOption(name, value) - - - env.SetOption(name, value) - - - + SetOption(name, value) + env.SetOption(name, value) + This function provides a way to set a select subset of the scons command line options from a SConscript file. The options supported are: - + clean -which corresponds to -c, --clean and --remove; +which corresponds to , +and ; @@ -4005,7 +3709,7 @@ which corresponds to -c, --clean and --remove; duplicate -which corresponds to --duplicate; +which corresponds to ; @@ -4013,7 +3717,7 @@ which corresponds to --duplicate; help -which corresponds to -h and --help; +which corresponds to and ; @@ -4021,7 +3725,7 @@ which corresponds to -h and --help; implicit_cache -which corresponds to --implicit-cache; +which corresponds to ; @@ -4029,7 +3733,7 @@ which corresponds to --implicit-cache; max_drift -which corresponds to --max-drift; +which corresponds to ; @@ -4037,7 +3741,9 @@ which corresponds to --max-drift; no_exec -which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; +which corresponds to , , +, +and ; @@ -4045,7 +3751,7 @@ which corresponds to -n, --no-exec, --just-print, --dry-run and --recon; num_jobs -which corresponds to -j and --jobs; +which corresponds to and ; @@ -4053,7 +3759,7 @@ which corresponds to -j and --jobs; random -which corresponds to --random; and +which corresponds to ; and @@ -4061,7 +3767,7 @@ which corresponds to --random; and silent -which corresponds to --silent. +which corresponds to . @@ -4076,30 +3782,25 @@ which corresponds to --stack-size. - + See the documentation for the -corresponding command line object for information about each specific +corresponding command line option for information about each specific option. - + Example: - + SetOption('max_drift', 1) - - SideEffect(side_effect, target) - - - env.SideEffect(side_effect, target) - - - + SideEffect(side_effect, target) + env.SideEffect(side_effect, target) + Declares side_effect as a side effect of building @@ -4117,7 +3818,7 @@ files for a static library, and various log files are created updated as side effects of various TeX commands. If a target is a side effect of multiple build commands, -scons +scons will ensure that only one set of commands is executed at a time. Consequently, you only need to use this method @@ -4125,7 +3826,7 @@ for side-effect targets that are built as a result of multiple build commands. - + Because multiple build commands may update the same side effect file, by default the @@ -4149,160 +3850,53 @@ is cleaned whenever a specific is cleaned, you must specify this explicitly with the -Clean +Clean or -env.Clean +env.Clean function. - - - SourceCode(entries, builder) - - - env.SourceCode(entries, builder) - - - -This function and its associate factory functions are deprecated. -There is no replacement. -The intended use was to keep a local tree in sync with an archive, -but in actuality the function only causes the archive -to be fetched on the first run. -Synchronizing with the archive is best done external to SCons. - - - -Arrange for non-existent source files to -be fetched from a source code management system -using the specified -builder. -The specified -entries -may be a Node, string or list of both, -and may represent either individual -source files or directories in which -source files can be found. - - - -For any non-existent source files, -scons -will search up the directory tree -and use the first -SourceCode -builder it finds. -The specified -builder -may be -None, -in which case -scons -will not use a builder to fetch -source files for the specified -entries, -even if a -SourceCode -builder has been specified -for a directory higher up the tree. - - - -scons -will, by default, -fetch files from SCCS or RCS subdirectories -without explicit configuration. -This takes some extra processing time -to search for the necessary -source code management files on disk. -You can avoid these extra searches -and speed up your build a little -by disabling these searches as follows: - - - -env.SourceCode('.', None) - - - -Note that if the specified -builder -is one you create by hand, -it must have an associated -construction environment to use -when fetching a source file. - - - -scons -provides a set of canned factory -functions that return appropriate -Builders for various popular -source code management systems. -Canonical examples of invocation include: - - - -env.SourceCode('.', env.BitKeeper('/usr/local/BKsources')) -env.SourceCode('src', env.CVS('/usr/local/CVSROOT')) -env.SourceCode('/', env.RCS()) -env.SourceCode(['f1.c', 'f2.c'], env.SCCS()) -env.SourceCode('no_source.c', None) - - - - - - - - Split(arg) - - - env.Split(arg) - - - + Split(arg) + env.Split(arg) + Returns a list of file names or other objects. -If arg is a string, +If arg is a string, it will be split on strings of white-space characters within the string, making it easier to write long lists of file names. -If arg is already a list, +If arg is already a list, the list will be returned untouched. -If arg is any other type of object, +If arg is any other type of object, it will be returned as a list containing just the object. - + Example: - + files = Split("f1.c f2.c f3.c") files = env.Split("f4.c f5.c f6.c") files = Split(""" - f7.c - f8.c - f9.c + f7.c + f8.c + f9.c """) - - env.subst(input, [raw, target, source, conv]) - - - + env.subst(input, [raw, target, source, conv]) + Performs construction variable interpolation on the specified string or sequence argument input. - + By default, leading or trailing white space will be removed from the result. @@ -4334,7 +3928,7 @@ pairs (as is done for signature calculation). - + If the input is a sequence (list or tuple), the individual elements of @@ -4342,7 +3936,7 @@ the sequence will be expanded, and the results will be returned as a list. - + The optional target and @@ -4351,20 +3945,20 @@ keyword arguments must be set to lists of target and source nodes, respectively, if you want the -$TARGET, -$TARGETS, -$SOURCE +$TARGET, +$TARGETS, +$SOURCE and -$SOURCES +$SOURCES to be available for expansion. This is usually necessary if you are calling -env.subst +env.subst from within a Python function used as an SCons action. - + Returned string values or sequence elements are converted to their string representation by default. The optional @@ -4382,11 +3976,11 @@ idiom to pass in an unnamed function that simply returns its unconverted argument. - + Example: - + print(env.subst("The C compiler is: $CC")) def compile(target, source, env): @@ -4400,23 +3994,20 @@ source_nodes = env.subst('$EXPAND_TO_NODELIST', - - Tag(node, tags) - - - + Tag(node, tags) + Annotates file or directory Nodes with information about how the -Package +Package Builder should package those files or directories. All tags are optional. - + Examples: - + # makes sure the built library will be installed with 0o644 file # access mode Tag( Library( 'lib.c' ), UNIX_ATTR="0o644" ) @@ -4427,81 +4018,71 @@ Tag( 'file2.txt', DOC ) - - Tool(string, [toolpath, **kw]) - - - env.Tool(string, [toolpath, **kw]) - - - -The -Tool -form of the function -returns a callable object -that can be used to initialize -a construction environment using the -tools keyword of the Environment() method. -The object may be called with a construction -environment as an argument, -in which case the object will -add the necessary variables -to the construction environment -and the name of the tool will be added to the -$TOOLS -construction variable. + Tool(name, [toolpath, **kwargs]) + env.Tool(name, [toolpath, **kwargs]) + +Runs the tool identified by +name, which is +searched for in standard locations and any +paths specified by the optional +toolpath, +to update a construction environment with construction variables +needed to use the mechanisms that tool describes. +Any additional keyword arguments +kwargs are passed +on to the tool module's generate function. - -Additional keyword arguments are passed to the tool's -generate() -method. + +When called as a construction environment method, +the tool module is called to update the +construction environment and the name of the tool is +appended to the $TOOLS +construction variable in that environment. - + Examples: - -env = Environment(tools = [ Tool('msvc') ]) - -env = Environment() -t = Tool('msvc') -t(env) # adds 'msvc' to the TOOLS variable -u = Tool('opengl', toolpath = ['tools']) -u(env) # adds 'opengl' to the TOOLS variable + +env.Tool('gcc') +env.Tool('opengl', toolpath=['build/tools']) - -The -env.Tool -form of the function -applies the callable object for the specified tool -string -to the environment through which the method was called. + +When called as a global function, +returns a callable tool object; +the tool is not called at this time, +as it lacks the context of an environment to update. +This tool object can be passed to an +Environment or Clone call +as part of the tools keyword argument, +or it can be called directly, +passing a construction environment to update as the argument. +Either approach will also update the +TOOLS construction variable. - -Additional keyword arguments are passed to the tool's -generate() -method. + +Examples: - -env.Tool('gcc') -env.Tool('opengl', toolpath = ['build/tools']) + +env = Environment(tools=[Tool('msvc')]) + +env = Environment() +t = Tool('msvc') +t(env) # adds 'msvc' to the TOOLS variable +u = Tool('opengl', toolpath = ['tools']) +u(env) # adds 'opengl' to the TOOLS variable - - Value(value, [built_value]) - - - env.Value(value, [built_value]) - - - + Value(value, [built_value], [name]) + env.Value(value, [built_value], [name]) + Returns a Node object representing the specified Python value. Value Nodes can be used as dependencies of targets. If the result of calling @@ -4513,9 +4094,13 @@ will be rebuilt. files are up-to-date.) When using timestamp source signatures, Value Nodes' timestamps are equal to the system time when the Node is created. +name can be provided as an alternative name +for the resulting Value node; this is advised +if the value parameter can't be converted to +a string. - + The returned Value Node object has a write() method that can be used to "build" a Value Node @@ -4531,11 +4116,11 @@ There is a corresponding method that will return the built value of the Node. - + Examples: - + env = Environment() def create(target, source, env): @@ -4571,16 +4156,11 @@ env.UpdateValue(target = Value(output), source = Value(input)) - - VariantDir(variant_dir, src_dir, [duplicate]) - - - env.VariantDir(variant_dir, src_dir, [duplicate]) - - - + VariantDir(variant_dir, src_dir, [duplicate]) + env.VariantDir(variant_dir, src_dir, [duplicate]) + Use the -VariantDir +VariantDir function to create a copy of your sources in another location: if a name under variant_dir @@ -4593,8 +4173,8 @@ than the original sources by simply refering to the sources (and targets) within the variant tree. - -VariantDir + +VariantDir can be called multiple times with the same src_dir to set up multiple builds with different options @@ -4612,9 +4192,9 @@ TODO: src_dir = '.' works fine with a build dir under it. --> - + The default behavior is for -scons +scons to physically duplicate the source files in the variant tree. Thus, a build performed in the variant tree is guaranteed to be identical to a build performed in the source tree even if @@ -4625,7 +4205,7 @@ or individual compilers or other invoked tools are hard-coded to put derived files in the same directory as source files. - + If possible on the platform, the duplication is performed by linking rather than copying; see also the @@ -4636,14 +4216,14 @@ files and directories that are not used are not present in variant_dir. - + Duplicating the source tree may be disabled by setting the duplicate argument to 0 (zero). This will cause -scons +scons to invoke Builders using the path names of source files in src_dir and the path names of derived files within @@ -4654,9 +4234,9 @@ and is usually safe for most builds (but see above for cases that may cause problems). - + Note that -VariantDir +VariantDir works most naturally with a subsidiary SConscript file. However, you would then call the subsidiary SConscript file not in the source directory, but in the @@ -4664,11 +4244,11 @@ not in the source directory, but in the regardless of the value of duplicate. This is how you tell -scons +scons which variant of a source tree to build: - + # run src/SConscript in two variant directories VariantDir('build/variant1', 'src') SConscript('build/variant1/SConscript') @@ -4676,31 +4256,31 @@ VariantDir('build/variant2', 'src') SConscript('build/variant2/SConscript') - + See also the -SConscript +SConscript function, described above, for another way to specify a variant directory in conjunction with calling a subsidiary SConscript file. - + Examples: - + # use names in the build directory, not the source directory VariantDir('build', 'src', duplicate=0) Program('build/prog', 'build/source.c') - + # this builds both the source and docs in a separate subtree VariantDir('build', '.', duplicate=0) SConscript(dirs=['build/src','build/doc']) - + # same as previous example, but only uses SConscript SConscript(dirs='src', variant_dir='build/src', duplicate=0) SConscript(dirs='doc', variant_dir='build/doc', duplicate=0) @@ -4708,61 +4288,58 @@ SConscript(dirs='doc', variant_dir='build/doc', duplicate=0) - - WhereIs(program, [path, pathext, reject]) - - - env.WhereIs(program, [path, pathext, reject]) - - - + WhereIs(program, [path, pathext, reject]) + env.WhereIs(program, [path, pathext, reject]) + Searches for the specified executable program, -returning the full path name to the program -if it is found, else None. -Searches the value of the +returning the full path to the program +or None. + + +When called as a construction environment method, +searches the paths in the path keyword argument, -or if None (the default) -the value of the calling environment's PATH -(env['ENV']['PATH']). -If path is None and -the env['ENV']['PATH'] key does not exist, -the user's current external PATH -(os.environ['PATH']) is used as fallback. - - +or if None (the default) +the paths listed in the construction environment +(env['ENV']['PATH']). +The external environment's path list +(os.environ['PATH']) +is used as a fallback if the key +env['ENV']['PATH'] +does not exist. + + On Windows systems, searches for executable programs with any of the file extensions listed in the pathext keyword argument, or if None (the default) -the calling environment's PATHEXT -(env['ENV']['PATHEXT']). -The user's current external PATHEXT +the pathname extensions listed in the construction environment +(env['ENV']['PATHEXT']). +The external environment's pathname extensions list (os.environ['PATHEXT']) -is used as a fallback if pathext is -None -and the key env['ENV']['PATHEXT'] +is used as a fallback if the key +env['ENV']['PATHEXT'] does not exist. - + +When called as a global function, uses the external +environment's path +os.environ['PATH'] +and path extensions +os.environ['PATHEXT'], +respectively, if +path and +pathext are +None. + + Will not select any path name or names -in the specified +in the optional reject -list, if any. +list. - - -If you would prefer to search -the user's current external PATH -(os.environ['PATH']) -by default, -consider using the function SCons.Util.WhereIs instead. -Note that SCons.Util.WhereIs -does not expand environment variables automatically -(no implicit env.subst for its arguments). - - diff --git a/doc/generated/functions.mod b/doc/generated/functions.mod index 47d2be4..9ff02a0 100644 --- a/doc/generated/functions.mod +++ b/doc/generated/functions.mod @@ -30,6 +30,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. Default"> DefaultEnvironment"> Depends"> +Detect"> Dictionary"> Dir"> Dump"> @@ -110,6 +111,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. env.Default"> env.DefaultEnvironment"> env.Depends"> +env.Detect"> env.Dictionary"> env.Dir"> env.Dump"> @@ -200,6 +202,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. Default"> DefaultEnvironment"> Depends"> +Detect"> Dictionary"> Dir"> Dump"> @@ -280,6 +283,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. env.Default"> env.DefaultEnvironment"> env.Depends"> +env.Detect"> env.Dictionary"> env.Dir"> env.Dump"> diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index 0d30f6f..e81eb09 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -1,4 +1,3 @@ - %scons; @@ -12,153 +11,137 @@ %variables-mod; ]> - + 386asm - - + Sets construction variables for the 386ASM assembler for the Phar Lap ETS embedded operating system. -Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.Uses: &cv-link-CC;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;. +Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $CC $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS aixc++ - - + Sets construction variables for the IMB xlc / Visual Age C++ compiler. -Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;. +Sets: $CXX $CXXVERSION $SHCXX $SHOBJSUFFIX aixcc - - + Sets construction variables for the IBM xlc / Visual Age C compiler. -Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCC;. +Sets: $CC $CCVERSION $SHCC aixf77 - - + Sets construction variables for the IBM Visual Age f77 Fortran compiler. -Sets: &cv-link-F77;, &cv-link-SHF77;. +Sets: $F77 $SHF77 aixlink - - + Sets construction variables for the IBM Visual Age linker. -Sets: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;. +Sets: $LINKFLAGS $SHLIBSUFFIX $SHLINKFLAGS applelink - - + Sets construction variables for the Apple linker (similar to the GNU linker). - Sets: &cv-link-APPLELINK_COMPATIBILITY_VERSION;, &cv-link-APPLELINK_CURRENT_VERSION;, &cv-link-APPLELINK_NO_COMPATIBILITY_VERSION;, &cv-link-APPLELINK_NO_CURRENT_VERSION;, &cv-link-FRAMEWORKPATHPREFIX;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LINKCOM;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-_APPLELINK_COMPATIBILITY_VERSION;, &cv-link-_APPLELINK_CURRENT_VERSION;, &cv-link-_FRAMEWORKPATH;, &cv-link-_FRAMEWORKS;.Uses: &cv-link-FRAMEWORKSFLAGS;. + Sets: $APPLELINK_COMPATIBILITY_VERSION $APPLELINK_CURRENT_VERSION $APPLELINK_NO_COMPATIBILITY_VERSION $APPLELINK_NO_CURRENT_VERSION $FRAMEWORKPATHPREFIX $LDMODULECOM $LDMODULEFLAGS $LDMODULEPREFIX $LDMODULESUFFIX $LINKCOM $SHLINKCOM $SHLINKFLAGS $_APPLELINK_COMPATIBILITY_VERSION $_APPLELINK_CURRENT_VERSION $_FRAMEWORKPATH $_FRAMEWORKS Uses: $FRAMEWORKSFLAGS ar - - -Sets construction variables for the ar library archiver. + +Sets construction variables for the ar library archiver. -Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-RANLIB;, &cv-link-RANLIBCOM;, &cv-link-RANLIBFLAGS;. +Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX $RANLIB $RANLIBCOM $RANLIBFLAGS as - - -Sets construction variables for the as assembler. + +Sets construction variables for the as assembler. -Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.Uses: &cv-link-CC;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;. +Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $CC $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS bcc32 - - + Sets construction variables for the bcc32 compiler. -Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHOBJSUFFIX;.Uses: &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;. +Sets: $CC $CCCOM $CCFLAGS $CFILESUFFIX $CFLAGS $CPPDEFPREFIX $CPPDEFSUFFIX $INCPREFIX $INCSUFFIX $SHCC $SHCCCOM $SHCCFLAGS $SHCFLAGS $SHOBJSUFFIX Uses: $_CPPDEFFLAGS $_CPPINCFLAGS cc - - + Sets construction variables for generic POSIX C compilers. -Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-FRAMEWORKPATH;, &cv-link-FRAMEWORKS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHOBJSUFFIX;.Uses: &cv-link-PLATFORM;. +Sets: $CC $CCCOM $CCFLAGS $CFILESUFFIX $CFLAGS $CPPDEFPREFIX $CPPDEFSUFFIX $FRAMEWORKPATH $FRAMEWORKS $INCPREFIX $INCSUFFIX $SHCC $SHCCCOM $SHCCFLAGS $SHCFLAGS $SHOBJSUFFIX Uses: $CCCOMSTR $PLATFORM $SHCCCOMSTR clang - - + Set construction variables for the Clang C compiler. -Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;. +Sets: $CC $CCVERSION $SHCCFLAGS clangxx - - + Set construction variables for the Clang C++ compiler. -Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;, &cv-link-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME;. +Sets: $CXX $CXXVERSION $SHCXXFLAGS $SHOBJSUFFIX $STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME cvf - - + Sets construction variables for the Compaq Visual Fortran compiler. -Sets: &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANMODDIR;, &cv-link-FORTRANMODDIRPREFIX;, &cv-link-FORTRANMODDIRSUFFIX;, &cv-link-FORTRANPPCOM;, &cv-link-OBJSUFFIX;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANPPCOM;.Uses: &cv-link-CPPFLAGS;, &cv-link-FORTRANFLAGS;, &cv-link-SHFORTRANFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_FORTRANINCFLAGS;, &cv-link-_FORTRANMODFLAG;. +Sets: $FORTRAN $FORTRANCOM $FORTRANMODDIR $FORTRANMODDIRPREFIX $FORTRANMODDIRSUFFIX $FORTRANPPCOM $OBJSUFFIX $SHFORTRANCOM $SHFORTRANPPCOM Uses: $CPPFLAGS $FORTRANFLAGS $SHFORTRANFLAGS $_CPPDEFFLAGS $_FORTRANINCFLAGS $_FORTRANMODFLAG cXX - - + Sets construction variables for generic POSIX C++ compilers. -Sets: &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-CXXFLAGS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-OBJSUFFIX;, &cv-link-SHCXX;, &cv-link-SHCXXCOM;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;.Uses: &cv-link-CXXCOMSTR;. +Sets: $CPPDEFPREFIX $CPPDEFSUFFIX $CXX $CXXCOM $CXXFILESUFFIX $CXXFLAGS $INCPREFIX $INCSUFFIX $OBJSUFFIX $SHCXX $SHCXXCOM $SHCXXFLAGS $SHOBJSUFFIX Uses: $CXXCOMSTR $SHCXXCOMSTR cyglink - - + Set construction variables for cygwin linker/loader. -Sets: &cv-link-IMPLIBPREFIX;, &cv-link-IMPLIBSUFFIX;, &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-LINKFLAGS;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLIBPREFIX;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLIBVERSIONFLAGS;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-_LDMODULEVERSIONFLAGS;, &cv-link-_SHLIBVERSIONFLAGS;. +Sets: $IMPLIBPREFIX $IMPLIBSUFFIX $LDMODULEVERSIONFLAGS $LINKFLAGS $RPATHPREFIX $RPATHSUFFIX $SHLIBPREFIX $SHLIBSUFFIX $SHLIBVERSIONFLAGS $SHLINKCOM $SHLINKFLAGS $_LDMODULEVERSIONFLAGS $_SHLIBVERSIONFLAGS default - - -Sets construction variables for a default list of Tool modules. + +Sets construction variables for a default list of Tool modules. Use default in the tools list to retain the original defaults, since the tools parameter is treated as a literal statement of the tools -to be made available in that construction environment, not an addition. +to be made available in that construction environment, not an addition. - + The list of tools selected by default is not static, but is dependent both on the platform and on the software installed on the platform. Some tools will not initialize if an underlying command is not found, and some tools are selected from a list of choices on a first-found basis. The finished tool list can be -examined by inspecting the TOOLS construction variable -in the construction environment. +examined by inspecting the TOOLS construction variable +in the construction environment. - + On all platforms, all tools from the following list are selected whose respective conditions are met: filesystem, wix, lex, yacc, rpcgen, swig, @@ -166,7 +149,7 @@ jar, javac, javah, rmic, dvipdf, dvips, gs, tex, latex, pdflatex, pdftex, tar, zip, textfile. - + On Linux systems, the default tools list selects (first-found): a C compiler from gcc, intelc, icc, cc; @@ -183,7 +166,7 @@ It also selects all found from the list m4, rpm. - + On Windows systems, the default tools list selects (first-found): a C compiler from msvc, mingw, gcc, intelc, icl, icc, cc, bcc32; @@ -201,7 +184,7 @@ It also selects all found from the list msvs, midl. - + On MacOS systems, the default tools list selects (first-found): a C compiler from gcc, cc; @@ -217,9 +200,9 @@ It also selects all found from the list m4, rpm. - + Default lists for other platforms can be found by -examining the scons +examining the scons source code (see SCons/Tool/__init__.py). @@ -228,16 +211,14 @@ source code (see dmd - - + Sets construction variables for D language compiler DMD. -Sets: &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DRPATHPREFIX;, &cv-link-DRPATHSUFFIX;, &cv-link-DShLibSonameGenerator;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLIBVERSION;, &cv-link-SHDLIBVERSIONFLAGS;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;. +Sets: $DC $DCOM $DDEBUG $DDEBUGPREFIX $DDEBUGSUFFIX $DFILESUFFIX $DFLAGPREFIX $DFLAGS $DFLAGSUFFIX $DINCPREFIX $DINCSUFFIX $DLIB $DLIBCOM $DLIBDIRPREFIX $DLIBDIRSUFFIX $DLIBFLAGPREFIX $DLIBFLAGSUFFIX $DLIBLINKPREFIX $DLIBLINKSUFFIX $DLINK $DLINKCOM $DLINKFLAGPREFIX $DLINKFLAGS $DLINKFLAGSUFFIX $DPATH $DRPATHPREFIX $DRPATHSUFFIX $DShLibSonameGenerator $DVERPREFIX $DVERSIONS $DVERSUFFIX $SHDC $SHDCOM $SHDLIBVERSION $SHDLIBVERSIONFLAGS $SHDLINK $SHDLINKCOM $SHDLINKFLAGS docbook - -This tool tries to make working with Docbook in SCons a little easier. + This tool tries to make working with Docbook in SCons a little easier. It provides several toolchains for creating different output formats, like HTML or PDF. Contained in the package is a distribution of the Docbook XSL stylesheets as of version 1.76.1. @@ -245,27 +226,27 @@ As long as you don't specify your own stylesheets for customization, these official versions are picked as default...which should reduce the inevitable setup hassles for you. -Implicit dependencies to images and XIncludes are detected automatically +Implicit dependencies to images and XIncludes are detected automatically if you meet the HTML requirements. The additional stylesheet utils/xmldepend.xsl by Paul DuBois is used for this purpose. -Note, that there is no support for XML catalog resolving offered! This tool calls +Note, that there is no support for XML catalog resolving offered! This tool calls the XSLT processors and PDF renderers with the stylesheets you specified, that's it. The rest lies in your hands and you still have to know what you're doing when resolving names via a catalog. -For activating the tool "docbook", you have to add its name to the Environment constructor, +For activating the tool "docbook", you have to add its name to the Environment constructor, like this -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) -On its startup, the Docbook tool tries to find a required xsltproc processor, and +On its startup, the Docbook tool tries to find a required xsltproc processor, and a PDF renderer, e.g. fop. So make sure that these are added to your system's environment PATH and can be called directly, without specifying their full path. -For the most basic processing of Docbook to HTML, you need to have installed +For the most basic processing of Docbook to HTML, you need to have installed -the Python lxml binding to libxml2, or +the Python lxml binding to libxml2, or the direct Python bindings for libxml2/libxslt, or @@ -276,49 +257,49 @@ and xalan. -Rendering to PDF requires you to have one of the applications +Rendering to PDF requires you to have one of the applications fop or xep installed. -Creating a HTML or PDF document is very simple and straightforward. Say +Creating a HTML or PDF document is very simple and straightforward. Say -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtml('manual.html', 'manual.xml') env.DocbookPdf('manual.pdf', 'manual.xml') -to get both outputs from your XML source manual.xml. As a shortcut, you can +to get both outputs from your XML source manual.xml. As a shortcut, you can give the stem of the filenames alone, like this: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtml('manual') env.DocbookPdf('manual') -and get the same result. Target and source lists are also supported: +and get the same result. Target and source lists are also supported: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtml(['manual.html','reference.html'], ['manual.xml','reference.xml']) -or even +or even -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtml(['manual','reference']) -Whenever you leave out the list of sources, you may not specify a file extension! The +Whenever you leave out the list of sources, you may not specify a file extension! The Tool uses the given names as file stems, and adds the suffixes for target and source files accordingly. -The rules given above are valid for the Builders DocbookHtml, -DocbookPdf, DocbookEpub, DocbookSlidesPdf and DocbookXInclude. For the -DocbookMan transformation you +The rules given above are valid for the Builders DocbookHtml, +DocbookPdf, DocbookEpub, DocbookSlidesPdf and DocbookXInclude. For the +DocbookMan transformation you can specify a target name, but the actual output names are automatically set from the refname entries in your XML source. -The Builders DocbookHtmlChunked, DocbookHtmlhelp and -DocbookSlidesHtml are special, in that: +The Builders DocbookHtmlChunked, DocbookHtmlhelp and +DocbookSlidesHtml are special, in that: -they create a large set of files, where the exact names and their number depend +they create a large set of files, where the exact names and their number depend on the content of the source file, and @@ -327,24 +308,24 @@ XSL transformation is not picked up by the stylesheets. -As a result, there is simply no use in specifying a target HTML name. +As a result, there is simply no use in specifying a target HTML name. So the basic syntax for these builders is always: -env = Environment(tools=['docbook']) +env = Environment(tools=['docbook']) env.DocbookHtmlhelp('manual') -If you want to use a specific XSL file, you can set the +If you want to use a specific XSL file, you can set the additional xsl parameter to your Builder call as follows: -env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl') +env.DocbookHtml('other.html', 'manual.xml', xsl='html.xsl') -Since this may get tedious if you always use the same local naming for your customized XSL files, +Since this may get tedious if you always use the same local naming for your customized XSL files, e.g. html.xsl for HTML and pdf.xsl for PDF output, a set of variables for setting the default XSL name is provided. These are: -DOCBOOK_DEFAULT_XSL_HTML +DOCBOOK_DEFAULT_XSL_HTML DOCBOOK_DEFAULT_XSL_HTMLCHUNKED DOCBOOK_DEFAULT_XSL_HTMLHELP DOCBOOK_DEFAULT_XSL_PDF @@ -353,735 +334,665 @@ DOCBOOK_DEFAULT_XSL_MAN DOCBOOK_DEFAULT_XSL_SLIDESPDF DOCBOOK_DEFAULT_XSL_SLIDESHTML -and you can set them when constructing your environment: +and you can set them when constructing your environment: -env = Environment(tools=['docbook'], +env = Environment(tools=['docbook'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') env.DocbookHtml('manual') # now uses html.xsl -Sets: &cv-link-DOCBOOK_DEFAULT_XSL_EPUB;, &cv-link-DOCBOOK_DEFAULT_XSL_HTML;, &cv-link-DOCBOOK_DEFAULT_XSL_HTMLCHUNKED;, &cv-link-DOCBOOK_DEFAULT_XSL_HTMLHELP;, &cv-link-DOCBOOK_DEFAULT_XSL_MAN;, &cv-link-DOCBOOK_DEFAULT_XSL_PDF;, &cv-link-DOCBOOK_DEFAULT_XSL_SLIDESHTML;, &cv-link-DOCBOOK_DEFAULT_XSL_SLIDESPDF;, &cv-link-DOCBOOK_FOP;, &cv-link-DOCBOOK_FOPCOM;, &cv-link-DOCBOOK_FOPFLAGS;, &cv-link-DOCBOOK_XMLLINT;, &cv-link-DOCBOOK_XMLLINTCOM;, &cv-link-DOCBOOK_XMLLINTFLAGS;, &cv-link-DOCBOOK_XSLTPROC;, &cv-link-DOCBOOK_XSLTPROCCOM;, &cv-link-DOCBOOK_XSLTPROCFLAGS;, &cv-link-DOCBOOK_XSLTPROCPARAMS;.Uses: &cv-link-DOCBOOK_FOPCOMSTR;, &cv-link-DOCBOOK_XMLLINTCOMSTR;, &cv-link-DOCBOOK_XSLTPROCCOMSTR;. +Sets: $DOCBOOK_DEFAULT_XSL_EPUB $DOCBOOK_DEFAULT_XSL_HTML $DOCBOOK_DEFAULT_XSL_HTMLCHUNKED $DOCBOOK_DEFAULT_XSL_HTMLHELP $DOCBOOK_DEFAULT_XSL_MAN $DOCBOOK_DEFAULT_XSL_PDF $DOCBOOK_DEFAULT_XSL_SLIDESHTML $DOCBOOK_DEFAULT_XSL_SLIDESPDF $DOCBOOK_FOP $DOCBOOK_FOPCOM $DOCBOOK_FOPFLAGS $DOCBOOK_XMLLINT $DOCBOOK_XMLLINTCOM $DOCBOOK_XMLLINTFLAGS $DOCBOOK_XSLTPROC $DOCBOOK_XSLTPROCCOM $DOCBOOK_XSLTPROCFLAGS $DOCBOOK_XSLTPROCPARAMS Uses: $DOCBOOK_FOPCOMSTR $DOCBOOK_XMLLINTCOMSTR $DOCBOOK_XSLTPROCCOMSTR dvi - - -Attaches the DVI builder to the + +Attaches the DVI builder to the construction environment. dvipdf - - + Sets construction variables for the dvipdf utility. -Sets: &cv-link-DVIPDF;, &cv-link-DVIPDFCOM;, &cv-link-DVIPDFFLAGS;.Uses: &cv-link-DVIPDFCOMSTR;. +Sets: $DVIPDF $DVIPDFCOM $DVIPDFFLAGS Uses: $DVIPDFCOMSTR dvips - - + Sets construction variables for the dvips utility. -Sets: &cv-link-DVIPS;, &cv-link-DVIPSFLAGS;, &cv-link-PSCOM;, &cv-link-PSPREFIX;, &cv-link-PSSUFFIX;.Uses: &cv-link-PSCOMSTR;. +Sets: $DVIPS $DVIPSFLAGS $PSCOM $PSPREFIX $PSSUFFIX Uses: $PSCOMSTR f03 - - + 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;. +Sets: $F03 $F03COM $F03FLAGS $F03PPCOM $SHF03 $SHF03COM $SHF03FLAGS $SHF03PPCOM $_F03INCFLAGS Uses: $F03COMSTR $F03PPCOMSTR $SHF03COMSTR $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;. +Sets: $F08 $F08COM $F08FLAGS $F08PPCOM $SHF08 $SHF08COM $SHF08FLAGS $SHF08PPCOM $_F08INCFLAGS Uses: $F08COMSTR $F08PPCOMSTR $SHF08COMSTR $SHF08PPCOMSTR f77 - - + Set construction variables for generic POSIX Fortran 77 compilers. -Sets: &cv-link-F77;, &cv-link-F77COM;, &cv-link-F77FILESUFFIXES;, &cv-link-F77FLAGS;, &cv-link-F77PPCOM;, &cv-link-F77PPFILESUFFIXES;, &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANFLAGS;, &cv-link-SHF77;, &cv-link-SHF77COM;, &cv-link-SHF77FLAGS;, &cv-link-SHF77PPCOM;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANFLAGS;, &cv-link-SHFORTRANPPCOM;, &cv-link-_F77INCFLAGS;.Uses: &cv-link-F77COMSTR;, &cv-link-F77PPCOMSTR;, &cv-link-FORTRANCOMSTR;, &cv-link-FORTRANPPCOMSTR;, &cv-link-SHF77COMSTR;, &cv-link-SHF77PPCOMSTR;, &cv-link-SHFORTRANCOMSTR;, &cv-link-SHFORTRANPPCOMSTR;. +Sets: $F77 $F77COM $F77FILESUFFIXES $F77FLAGS $F77PPCOM $F77PPFILESUFFIXES $FORTRAN $FORTRANCOM $FORTRANFLAGS $SHF77 $SHF77COM $SHF77FLAGS $SHF77PPCOM $SHFORTRAN $SHFORTRANCOM $SHFORTRANFLAGS $SHFORTRANPPCOM $_F77INCFLAGS Uses: $F77COMSTR $F77PPCOMSTR $FORTRANCOMSTR $FORTRANPPCOMSTR $SHF77COMSTR $SHF77PPCOMSTR $SHFORTRANCOMSTR $SHFORTRANPPCOMSTR f90 - - + Set construction variables for generic POSIX Fortran 90 compilers. -Sets: &cv-link-F90;, &cv-link-F90COM;, &cv-link-F90FLAGS;, &cv-link-F90PPCOM;, &cv-link-SHF90;, &cv-link-SHF90COM;, &cv-link-SHF90FLAGS;, &cv-link-SHF90PPCOM;, &cv-link-_F90INCFLAGS;.Uses: &cv-link-F90COMSTR;, &cv-link-F90PPCOMSTR;, &cv-link-SHF90COMSTR;, &cv-link-SHF90PPCOMSTR;. +Sets: $F90 $F90COM $F90FLAGS $F90PPCOM $SHF90 $SHF90COM $SHF90FLAGS $SHF90PPCOM $_F90INCFLAGS Uses: $F90COMSTR $F90PPCOMSTR $SHF90COMSTR $SHF90PPCOMSTR f95 - - + Set construction variables for generic POSIX Fortran 95 compilers. -Sets: &cv-link-F95;, &cv-link-F95COM;, &cv-link-F95FLAGS;, &cv-link-F95PPCOM;, &cv-link-SHF95;, &cv-link-SHF95COM;, &cv-link-SHF95FLAGS;, &cv-link-SHF95PPCOM;, &cv-link-_F95INCFLAGS;.Uses: &cv-link-F95COMSTR;, &cv-link-F95PPCOMSTR;, &cv-link-SHF95COMSTR;, &cv-link-SHF95PPCOMSTR;. +Sets: $F95 $F95COM $F95FLAGS $F95PPCOM $SHF95 $SHF95COM $SHF95FLAGS $SHF95PPCOM $_F95INCFLAGS Uses: $F95COMSTR $F95PPCOMSTR $SHF95COMSTR $SHF95PPCOMSTR fortran - - + Set construction variables for generic POSIX Fortran compilers. -Sets: &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANFLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANFLAGS;, &cv-link-SHFORTRANPPCOM;.Uses: &cv-link-FORTRANCOMSTR;, &cv-link-FORTRANPPCOMSTR;, &cv-link-SHFORTRANCOMSTR;, &cv-link-SHFORTRANPPCOMSTR;. +Sets: $FORTRAN $FORTRANCOM $FORTRANFLAGS $SHFORTRAN $SHFORTRANCOM $SHFORTRANFLAGS $SHFORTRANPPCOM Uses: $FORTRANCOMSTR $FORTRANPPCOMSTR $SHFORTRANCOMSTR $SHFORTRANPPCOMSTR g++ - - -Set construction variables for the gXX C++ compiler. + +Set construction variables for the gXX C++ compiler. -Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;. +Sets: $CXX $CXXVERSION $SHCXXFLAGS $SHOBJSUFFIX g77 - - -Set construction variables for the g77 Fortran compiler. -Calls the f77 Tool module + +Set construction variables for the g77 Fortran compiler. +Calls the f77 Tool module to set variables. gas - - -Sets construction variables for the gas assembler. -Calls the as module. + +Sets construction variables for the gas assembler. +Calls the as module. -Sets: &cv-link-AS;. +Sets: $AS gcc - - -Set construction variables for the gcc C compiler. + +Set construction variables for the gcc C compiler. -Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;. +Sets: $CC $CCVERSION $SHCCFLAGS gdc - - + Sets construction variables for the D language compiler GDC. -Sets: &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DRPATHPREFIX;, &cv-link-DRPATHSUFFIX;, &cv-link-DShLibSonameGenerator;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLIBVERSION;, &cv-link-SHDLIBVERSIONFLAGS;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;. +Sets: $DC $DCOM $DDEBUG $DDEBUGPREFIX $DDEBUGSUFFIX $DFILESUFFIX $DFLAGPREFIX $DFLAGS $DFLAGSUFFIX $DINCPREFIX $DINCSUFFIX $DLIB $DLIBCOM $DLIBDIRPREFIX $DLIBDIRSUFFIX $DLIBFLAGPREFIX $DLIBFLAGSUFFIX $DLIBLINKPREFIX $DLIBLINKSUFFIX $DLINK $DLINKCOM $DLINKFLAGPREFIX $DLINKFLAGS $DLINKFLAGSUFFIX $DPATH $DRPATHPREFIX $DRPATHSUFFIX $DShLibSonameGenerator $DVERPREFIX $DVERSIONS $DVERSUFFIX $SHDC $SHDCOM $SHDLIBVERSION $SHDLIBVERSIONFLAGS $SHDLINK $SHDLINKCOM $SHDLINKFLAGS gettext - - + This is actually a toolset, which supports internationalization and localization of software being constructed with SCons. The toolset loads following tools: - + - xgettext - to extract internationalized messages from source code to + xgettext - to extract internationalized messages from source code to POT file(s), - msginit - may be optionally used to initialize PO + msginit - may be optionally used to initialize PO files, - msgmerge - to update PO files, that already contain + msgmerge - to update PO files, that already contain translated messages, - msgfmt - to compile textual PO file to binary + msgfmt - to compile textual PO file to binary installable MO file. - -When you enable gettext, it internally loads all abovementioned tools, + +When you enable gettext, it internally loads all abovementioned tools, so you're encouraged to see their individual documentation. - + Each of the above tools provides its own builder(s) which may be used to perform particular activities related to software internationalization. You may be however interested in top-level builder -Translate described few paragraphs later. +Translate described few paragraphs later. - -To use gettext tools add 'gettext' tool to your + +To use gettext tools add 'gettext' tool to your environment: - + env = Environment( tools = ['default', 'gettext'] ) gfortran - - + Sets construction variables for the GNU F95/F2003 GNU compiler. -Sets: &cv-link-F77;, &cv-link-F90;, &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. +Sets: $F77 $F90 $F95 $FORTRAN $SHF77 $SHF77FLAGS $SHF90 $SHF90FLAGS $SHF95 $SHF95FLAGS $SHFORTRAN $SHFORTRANFLAGS gnulink - - + Set construction variables for GNU linker/loader. -Sets: &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLIBVERSIONFLAGS;, &cv-link-SHLINKFLAGS;, &cv-link-_LDMODULESONAME;, &cv-link-_SHLIBSONAME;. +Sets: $LDMODULEVERSIONFLAGS $RPATHPREFIX $RPATHSUFFIX $SHLIBVERSIONFLAGS $SHLINKFLAGS $_LDMODULESONAME $_SHLIBSONAME gs - - + This Tool sets the required construction variables for working with the Ghostscript command. It also registers an appropriate Action -with the PDF Builder (PDF), such that the conversion from +with the PDF Builder (PDF), such that the conversion from PS/EPS to PDF happens automatically for the TeX/LaTeX toolchain. -Finally, it adds an explicit Ghostscript Builder (Gs) to the +Finally, it adds an explicit Ghostscript Builder (Gs) to the environment. -Sets: &cv-link-GS;, &cv-link-GSCOM;, &cv-link-GSFLAGS;.Uses: &cv-link-GSCOMSTR;. +Sets: $GS $GSCOM $GSFLAGS Uses: $GSCOMSTR hpc++ - - + Set construction variables for the compilers aCC on HP/UX systems. hpcc - - + Set construction variables for the aCC on HP/UX systems. -Calls the cXX tool for additional variables. +Calls the cXX tool for additional variables. -Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;. +Sets: $CXX $CXXVERSION $SHCXXFLAGS hplink - - + Sets construction variables for the linker on HP/UX systems. -Sets: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;. +Sets: $LINKFLAGS $SHLIBSUFFIX $SHLINKFLAGS icc - - + Sets construction variables for the icc compiler on OS/2 systems. -Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CFILESUFFIX;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;.Uses: &cv-link-CCFLAGS;, &cv-link-CFLAGS;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;. +Sets: $CC $CCCOM $CFILESUFFIX $CPPDEFPREFIX $CPPDEFSUFFIX $CXXCOM $CXXFILESUFFIX $INCPREFIX $INCSUFFIX Uses: $CCFLAGS $CFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS icl - - + Sets construction variables for the Intel C/C++ compiler. -Calls the intelc Tool module to set its variables. +Calls the intelc Tool module to set its variables. ifl - - + Sets construction variables for the Intel Fortran compiler. -Sets: &cv-link-FORTRAN;, &cv-link-FORTRANCOM;, &cv-link-FORTRANPPCOM;, &cv-link-SHFORTRANCOM;, &cv-link-SHFORTRANPPCOM;.Uses: &cv-link-CPPFLAGS;, &cv-link-FORTRANFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_FORTRANINCFLAGS;. +Sets: $FORTRAN $FORTRANCOM $FORTRANPPCOM $SHFORTRANCOM $SHFORTRANPPCOM Uses: $CPPFLAGS $FORTRANFLAGS $_CPPDEFFLAGS $_FORTRANINCFLAGS ifort - - + Sets construction variables for newer versions of the Intel Fortran compiler for Linux. -Sets: &cv-link-F77;, &cv-link-F90;, &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. +Sets: $F77 $F90 $F95 $FORTRAN $SHF77 $SHF77FLAGS $SHF90 $SHF90FLAGS $SHF95 $SHF95FLAGS $SHFORTRAN $SHFORTRANFLAGS ilink - - + Sets construction variables for the ilink linker on OS/2 systems. -Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;. +Sets: $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS ilink32 - - + Sets construction variables for the Borland ilink32 linker. -Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;. +Sets: $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS install - - + Sets construction variables for file and directory installation. -Sets: &cv-link-INSTALL;, &cv-link-INSTALLSTR;. +Sets: $INSTALL $INSTALLSTR intelc - - + Sets construction variables for the Intel C/C++ compiler (Linux and Windows, version 7 and later). -Calls the gcc or msvc +Calls the gcc or msvc (on Linux and Windows, respectively) to set underlying variables. -Sets: &cv-link-AR;, &cv-link-CC;, &cv-link-CXX;, &cv-link-INTEL_C_COMPILER_VERSION;, &cv-link-LINK;. +Sets: $AR $CC $CXX $INTEL_C_COMPILER_VERSION $LINK jar - - -Sets construction variables for the jar utility. + +Sets construction variables for the jar utility. -Sets: &cv-link-JAR;, &cv-link-JARCOM;, &cv-link-JARFLAGS;, &cv-link-JARSUFFIX;.Uses: &cv-link-JARCOMSTR;. +Sets: $JAR $JARCOM $JARFLAGS $JARSUFFIX Uses: $JARCOMSTR javac - - - Sets construction variables for the javac compiler. + + Sets construction variables for the javac compiler. - Sets: &cv-link-JAVABOOTCLASSPATH;, &cv-link-JAVAC;, &cv-link-JAVACCOM;, &cv-link-JAVACFLAGS;, &cv-link-JAVACLASSPATH;, &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVAINCLUDES;, &cv-link-JAVASOURCEPATH;, &cv-link-JAVASUFFIX;.Uses: &cv-link-JAVACCOMSTR;. + Sets: $JAVABOOTCLASSPATH $JAVAC $JAVACCOM $JAVACFLAGS $JAVACLASSPATH $JAVACLASSSUFFIX $JAVAINCLUDES $JAVASOURCEPATH $JAVASUFFIX Uses: $JAVACCOMSTR javah - - -Sets construction variables for the javah tool. + +Sets construction variables for the javah tool. -Sets: &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVAH;, &cv-link-JAVAHCOM;, &cv-link-JAVAHFLAGS;.Uses: &cv-link-JAVACLASSPATH;, &cv-link-JAVAHCOMSTR;. +Sets: $JAVACLASSSUFFIX $JAVAH $JAVAHCOM $JAVAHFLAGS Uses: $JAVACLASSPATH $JAVAHCOMSTR latex - - -Sets construction variables for the latex utility. + +Sets construction variables for the latex utility. -Sets: &cv-link-LATEX;, &cv-link-LATEXCOM;, &cv-link-LATEXFLAGS;.Uses: &cv-link-LATEXCOMSTR;. +Sets: $LATEX $LATEXCOM $LATEXFLAGS Uses: $LATEXCOMSTR ldc - - + Sets construction variables for the D language compiler LDC2. -Sets: &cv-link-DC;, &cv-link-DCOM;, &cv-link-DDEBUG;, &cv-link-DDEBUGPREFIX;, &cv-link-DDEBUGSUFFIX;, &cv-link-DFILESUFFIX;, &cv-link-DFLAGPREFIX;, &cv-link-DFLAGS;, &cv-link-DFLAGSUFFIX;, &cv-link-DINCPREFIX;, &cv-link-DINCSUFFIX;, &cv-link-DLIB;, &cv-link-DLIBCOM;, &cv-link-DLIBDIRPREFIX;, &cv-link-DLIBDIRSUFFIX;, &cv-link-DLIBFLAGPREFIX;, &cv-link-DLIBFLAGSUFFIX;, &cv-link-DLIBLINKPREFIX;, &cv-link-DLIBLINKSUFFIX;, &cv-link-DLINK;, &cv-link-DLINKCOM;, &cv-link-DLINKFLAGPREFIX;, &cv-link-DLINKFLAGS;, &cv-link-DLINKFLAGSUFFIX;, &cv-link-DPATH;, &cv-link-DRPATHPREFIX;, &cv-link-DRPATHSUFFIX;, &cv-link-DShLibSonameGenerator;, &cv-link-DVERPREFIX;, &cv-link-DVERSIONS;, &cv-link-DVERSUFFIX;, &cv-link-SHDC;, &cv-link-SHDCOM;, &cv-link-SHDLIBVERSION;, &cv-link-SHDLIBVERSIONFLAGS;, &cv-link-SHDLINK;, &cv-link-SHDLINKCOM;, &cv-link-SHDLINKFLAGS;. +Sets: $DC $DCOM $DDEBUG $DDEBUGPREFIX $DDEBUGSUFFIX $DFILESUFFIX $DFLAGPREFIX $DFLAGS $DFLAGSUFFIX $DINCPREFIX $DINCSUFFIX $DLIB $DLIBCOM $DLIBDIRPREFIX $DLIBDIRSUFFIX $DLIBFLAGPREFIX $DLIBFLAGSUFFIX $DLIBLINKPREFIX $DLIBLINKSUFFIX $DLINK $DLINKCOM $DLINKFLAGPREFIX $DLINKFLAGS $DLINKFLAGSUFFIX $DPATH $DRPATHPREFIX $DRPATHSUFFIX $DShLibSonameGenerator $DVERPREFIX $DVERSIONS $DVERSUFFIX $SHDC $SHDCOM $SHDLIBVERSION $SHDLIBVERSIONFLAGS $SHDLINK $SHDLINKCOM $SHDLINKFLAGS lex - - -Sets construction variables for the lex lexical analyser. + +Sets construction variables for the lex lexical analyser. -Sets: &cv-link-LEX;, &cv-link-LEXCOM;, &cv-link-LEXFLAGS;, &cv-link-LEXUNISTD;.Uses: &cv-link-LEXCOMSTR;. +Sets: $LEX $LEXCOM $LEXFLAGS $LEXUNISTD Uses: $LEXCOMSTR link - - + Sets construction variables for generic POSIX linkers. This is a "smart" linker tool which selects a compiler to complete the linking based on the types of source files. -Sets: &cv-link-LDMODULE;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULENOVERSIONSYMLINKS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LDMODULEVERSION;, &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-__LDMODULEVERSIONFLAGS;, &cv-link-__SHLIBVERSIONFLAGS;.Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;. +Sets: $LDMODULE $LDMODULECOM $LDMODULEFLAGS $LDMODULENOVERSIONSYMLINKS $LDMODULEPREFIX $LDMODULESUFFIX $LDMODULEVERSION $LDMODULEVERSIONFLAGS $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS $SHLIBSUFFIX $SHLINK $SHLINKCOM $SHLINKFLAGS $__LDMODULEVERSIONFLAGS $__SHLIBVERSIONFLAGS Uses: $LDMODULECOMSTR $LINKCOMSTR $SHLINKCOMSTR linkloc - - + Sets construction variables for the LinkLoc linker for the Phar Lap ETS embedded operating system. -Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;.Uses: &cv-link-LINKCOMSTR;, &cv-link-SHLINKCOMSTR;. +Sets: $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS $SHLINK $SHLINKCOM $SHLINKFLAGS Uses: $LINKCOMSTR $SHLINKCOMSTR m4 - - -Sets construction variables for the m4 macro processor. + +Sets construction variables for the m4 macro processor. -Sets: &cv-link-M4;, &cv-link-M4COM;, &cv-link-M4FLAGS;.Uses: &cv-link-M4COMSTR;. +Sets: $M4 $M4COM $M4FLAGS Uses: $M4COMSTR masm - - + Sets construction variables for the Microsoft assembler. -Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;, &cv-link-CPPFLAGS;, &cv-link-_CPPDEFFLAGS;, &cv-link-_CPPINCFLAGS;. +Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $ASCOMSTR $ASPPCOMSTR $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS midl - - + Sets construction variables for the Microsoft IDL compiler. -Sets: &cv-link-MIDL;, &cv-link-MIDLCOM;, &cv-link-MIDLFLAGS;.Uses: &cv-link-MIDLCOMSTR;. +Sets: $MIDL $MIDLCOM $MIDLFLAGS Uses: $MIDLCOMSTR mingw - - + Sets construction variables for MinGW (Minimal Gnu on Windows). -Sets: &cv-link-AS;, &cv-link-CC;, &cv-link-CXX;, &cv-link-LDMODULECOM;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-OBJSUFFIX;, &cv-link-RC;, &cv-link-RCCOM;, &cv-link-RCFLAGS;, &cv-link-RCINCFLAGS;, &cv-link-RCINCPREFIX;, &cv-link-RCINCSUFFIX;, &cv-link-SHCCFLAGS;, &cv-link-SHCXXFLAGS;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-SHOBJSUFFIX;, &cv-link-WINDOWSDEFPREFIX;, &cv-link-WINDOWSDEFSUFFIX;.Uses: &cv-link-RCCOMSTR;, &cv-link-SHLINKCOMSTR;. +Sets: $AS $CC $CXX $LDMODULECOM $LIBPREFIX $LIBSUFFIX $OBJSUFFIX $RC $RCCOM $RCFLAGS $RCINCFLAGS $RCINCPREFIX $RCINCSUFFIX $SHCCFLAGS $SHCXXFLAGS $SHLINKCOM $SHLINKFLAGS $SHOBJSUFFIX $WINDOWSDEFPREFIX $WINDOWSDEFSUFFIX Uses: $RCCOMSTR $SHLINKCOMSTR msgfmt - - -This scons tool is a part of scons gettext toolset. It provides scons + +This scons tool is a part of scons gettext toolset. It provides scons interface to msgfmt(1) command, which generates binary message catalog (MO) from a textual translation description (PO). -Sets: &cv-link-MOSUFFIX;, &cv-link-MSGFMT;, &cv-link-MSGFMTCOM;, &cv-link-MSGFMTCOMSTR;, &cv-link-MSGFMTFLAGS;, &cv-link-POSUFFIX;.Uses: &cv-link-LINGUAS_FILE;. +Sets: $MOSUFFIX $MSGFMT $MSGFMTCOM $MSGFMTCOMSTR $MSGFMTFLAGS $POSUFFIX Uses: $LINGUAS_FILE msginit - - -This scons tool is a part of scons gettext toolset. It provides + +This scons tool is a part of scons gettext toolset. It provides scons interface to msginit(1) program, which creates new PO file, initializing the meta information with values from user's environment (or options). -Sets: &cv-link-MSGINIT;, &cv-link-MSGINITCOM;, &cv-link-MSGINITCOMSTR;, &cv-link-MSGINITFLAGS;, &cv-link-POAUTOINIT;, &cv-link-POCREATE_ALIAS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-_MSGINITLOCALE;.Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;. +Sets: $MSGINIT $MSGINITCOM $MSGINITCOMSTR $MSGINITFLAGS $POAUTOINIT $POCREATE_ALIAS $POSUFFIX $POTSUFFIX $_MSGINITLOCALE Uses: $LINGUAS_FILE $POAUTOINIT $POTDOMAIN msgmerge - - -This scons tool is a part of scons gettext toolset. It provides + +This scons tool is a part of scons gettext toolset. It provides scons interface to msgmerge(1) command, which merges two Uniform style .po files together. -Sets: &cv-link-MSGMERGE;, &cv-link-MSGMERGECOM;, &cv-link-MSGMERGECOMSTR;, &cv-link-MSGMERGEFLAGS;, &cv-link-POSUFFIX;, &cv-link-POTSUFFIX;, &cv-link-POUPDATE_ALIAS;.Uses: &cv-link-LINGUAS_FILE;, &cv-link-POAUTOINIT;, &cv-link-POTDOMAIN;. +Sets: $MSGMERGE $MSGMERGECOM $MSGMERGECOMSTR $MSGMERGEFLAGS $POSUFFIX $POTSUFFIX $POUPDATE_ALIAS Uses: $LINGUAS_FILE $POAUTOINIT $POTDOMAIN mslib - - + Sets construction variables for the Microsoft mslib library archiver. -Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.Uses: &cv-link-ARCOMSTR;. +Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX Uses: $ARCOMSTR mslink - - + Sets construction variables for the Microsoft linker. -Sets: &cv-link-LDMODULE;, &cv-link-LDMODULECOM;, &cv-link-LDMODULEFLAGS;, &cv-link-LDMODULEPREFIX;, &cv-link-LDMODULESUFFIX;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;, &cv-link-REGSVR;, &cv-link-REGSVRCOM;, &cv-link-REGSVRFLAGS;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;, &cv-link-WIN32DEFPREFIX;, &cv-link-WIN32DEFSUFFIX;, &cv-link-WIN32EXPPREFIX;, &cv-link-WIN32EXPSUFFIX;, &cv-link-WINDOWSDEFPREFIX;, &cv-link-WINDOWSDEFSUFFIX;, &cv-link-WINDOWSEXPPREFIX;, &cv-link-WINDOWSEXPSUFFIX;, &cv-link-WINDOWSPROGMANIFESTPREFIX;, &cv-link-WINDOWSPROGMANIFESTSUFFIX;, &cv-link-WINDOWSSHLIBMANIFESTPREFIX;, &cv-link-WINDOWSSHLIBMANIFESTSUFFIX;, &cv-link-WINDOWS_INSERT_DEF;.Uses: &cv-link-LDMODULECOMSTR;, &cv-link-LINKCOMSTR;, &cv-link-REGSVRCOMSTR;, &cv-link-SHLINKCOMSTR;. +Sets: $LDMODULE $LDMODULECOM $LDMODULEFLAGS $LDMODULEPREFIX $LDMODULESUFFIX $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS $REGSVR $REGSVRCOM $REGSVRFLAGS $SHLINK $SHLINKCOM $SHLINKFLAGS $WIN32DEFPREFIX $WIN32DEFSUFFIX $WIN32EXPPREFIX $WIN32EXPSUFFIX $WINDOWSDEFPREFIX $WINDOWSDEFSUFFIX $WINDOWSEXPPREFIX $WINDOWSEXPSUFFIX $WINDOWSPROGMANIFESTPREFIX $WINDOWSPROGMANIFESTSUFFIX $WINDOWSSHLIBMANIFESTPREFIX $WINDOWSSHLIBMANIFESTSUFFIX $WINDOWS_INSERT_DEF Uses: $LDMODULECOMSTR $LINKCOMSTR $REGSVRCOMSTR $SHLINKCOMSTR mssdk - - + Sets variables for Microsoft Platform SDK and/or Windows SDK. Note that unlike most other Tool modules, mssdk does not set construction variables, but sets the environment variables -in the environment SCons uses to execute +in the environment SCons uses to execute the Microsoft toolchain: %INCLUDE%, %LIB%, %LIBPATH% and %PATH%. -Uses: &cv-link-MSSDK_DIR;, &cv-link-MSSDK_VERSION;, &cv-link-MSVS_VERSION;. +Uses: $MSSDK_DIR $MSSDK_VERSION $MSVS_VERSION msvc - - + Sets construction variables for the Microsoft Visual C/C++ compiler. -Sets: &cv-link-BUILDERS;, &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CCFLAGS;, &cv-link-CCPCHFLAGS;, &cv-link-CCPDBFLAGS;, &cv-link-CFILESUFFIX;, &cv-link-CFLAGS;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-CXXFLAGS;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-OBJPREFIX;, &cv-link-OBJSUFFIX;, &cv-link-PCHCOM;, &cv-link-PCHPDBFLAGS;, &cv-link-RC;, &cv-link-RCCOM;, &cv-link-RCFLAGS;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHCXX;, &cv-link-SHCXXCOM;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;.Uses: &cv-link-CCCOMSTR;, &cv-link-CXXCOMSTR;, &cv-link-PCH;, &cv-link-PCHSTOP;, &cv-link-PDB;, &cv-link-SHCCCOMSTR;, &cv-link-SHCXXCOMSTR;. +Sets: $BUILDERS $CC $CCCOM $CCFLAGS $CCPCHFLAGS $CCPDBFLAGS $CFILESUFFIX $CFLAGS $CPPDEFPREFIX $CPPDEFSUFFIX $CXX $CXXCOM $CXXFILESUFFIX $CXXFLAGS $INCPREFIX $INCSUFFIX $OBJPREFIX $OBJSUFFIX $PCHCOM $PCHPDBFLAGS $RC $RCCOM $RCFLAGS $SHCC $SHCCCOM $SHCCFLAGS $SHCFLAGS $SHCXX $SHCXXCOM $SHCXXFLAGS $SHOBJPREFIX $SHOBJSUFFIX Uses: $CCCOMSTR $CXXCOMSTR $PCH $PCHSTOP $PDB $SHCCCOMSTR $SHCXXCOMSTR 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: $MSVSBUILDCOM $MSVSCLEANCOM $MSVSENCODING $MSVSPROJECTCOM $MSVSREBUILDCOM $MSVSSCONS $MSVSSCONSCOM $MSVSSCONSCRIPT $MSVSSCONSFLAGS $MSVSSOLUTIONCOM mwcc - - + Sets construction variables for the Metrowerks CodeWarrior compiler. -Sets: &cv-link-CC;, &cv-link-CCCOM;, &cv-link-CFILESUFFIX;, &cv-link-CPPDEFPREFIX;, &cv-link-CPPDEFSUFFIX;, &cv-link-CXX;, &cv-link-CXXCOM;, &cv-link-CXXFILESUFFIX;, &cv-link-INCPREFIX;, &cv-link-INCSUFFIX;, &cv-link-MWCW_VERSION;, &cv-link-MWCW_VERSIONS;, &cv-link-SHCC;, &cv-link-SHCCCOM;, &cv-link-SHCCFLAGS;, &cv-link-SHCFLAGS;, &cv-link-SHCXX;, &cv-link-SHCXXCOM;, &cv-link-SHCXXFLAGS;.Uses: &cv-link-CCCOMSTR;, &cv-link-CXXCOMSTR;, &cv-link-SHCCCOMSTR;, &cv-link-SHCXXCOMSTR;. +Sets: $CC $CCCOM $CFILESUFFIX $CPPDEFPREFIX $CPPDEFSUFFIX $CXX $CXXCOM $CXXFILESUFFIX $INCPREFIX $INCSUFFIX $MWCW_VERSION $MWCW_VERSIONS $SHCC $SHCCCOM $SHCCFLAGS $SHCFLAGS $SHCXX $SHCXXCOM $SHCXXFLAGS Uses: $CCCOMSTR $CXXCOMSTR $SHCCCOMSTR $SHCXXCOMSTR mwld - - + Sets construction variables for the Metrowerks CodeWarrior linker. -Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-SHLINK;, &cv-link-SHLINKCOM;, &cv-link-SHLINKFLAGS;. +Sets: $AR $ARCOM $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $SHLINK $SHLINKCOM $SHLINKFLAGS nasm - - + Sets construction variables for the nasm Netwide Assembler. -Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;. - - - Packaging - - -Sets construction variables for the Package Builder. - - +Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $ASCOMSTR $ASPPCOMSTR packaging - - + A framework for building binary and source packages. + + Packaging + +Sets construction variables for the Package Builder. + + + pdf - - + Sets construction variables for the Portable Document Format builder. -Sets: &cv-link-PDFPREFIX;, &cv-link-PDFSUFFIX;. +Sets: $PDFPREFIX $PDFSUFFIX pdflatex - - -Sets construction variables for the pdflatex utility. + +Sets construction variables for the pdflatex utility. -Sets: &cv-link-LATEXRETRIES;, &cv-link-PDFLATEX;, &cv-link-PDFLATEXCOM;, &cv-link-PDFLATEXFLAGS;.Uses: &cv-link-PDFLATEXCOMSTR;. +Sets: $LATEXRETRIES $PDFLATEX $PDFLATEXCOM $PDFLATEXFLAGS Uses: $PDFLATEXCOMSTR pdftex - - -Sets construction variables for the pdftex utility. + +Sets construction variables for the pdftex utility. -Sets: &cv-link-LATEXRETRIES;, &cv-link-PDFLATEX;, &cv-link-PDFLATEXCOM;, &cv-link-PDFLATEXFLAGS;, &cv-link-PDFTEX;, &cv-link-PDFTEXCOM;, &cv-link-PDFTEXFLAGS;.Uses: &cv-link-PDFLATEXCOMSTR;, &cv-link-PDFTEXCOMSTR;. +Sets: $LATEXRETRIES $PDFLATEX $PDFLATEXCOM $PDFLATEXFLAGS $PDFTEX $PDFTEXCOM $PDFTEXFLAGS Uses: $PDFLATEXCOMSTR $PDFTEXCOMSTR + + + python + +Loads the Python scanner scanner into the invoking environment. When loaded, the scanner will +attempt to find implicit dependencies for any Python source files in the list of sources +provided to an actual that uses this environment. + + qt - - + Sets construction variables for building Qt applications. -Sets: &cv-link-QTDIR;, &cv-link-QT_AUTOSCAN;, &cv-link-QT_BINPATH;, &cv-link-QT_CPPPATH;, &cv-link-QT_LIB;, &cv-link-QT_LIBPATH;, &cv-link-QT_MOC;, &cv-link-QT_MOCCXXPREFIX;, &cv-link-QT_MOCCXXSUFFIX;, &cv-link-QT_MOCFROMCXXCOM;, &cv-link-QT_MOCFROMCXXFLAGS;, &cv-link-QT_MOCFROMHCOM;, &cv-link-QT_MOCFROMHFLAGS;, &cv-link-QT_MOCHPREFIX;, &cv-link-QT_MOCHSUFFIX;, &cv-link-QT_UIC;, &cv-link-QT_UICCOM;, &cv-link-QT_UICDECLFLAGS;, &cv-link-QT_UICDECLPREFIX;, &cv-link-QT_UICDECLSUFFIX;, &cv-link-QT_UICIMPLFLAGS;, &cv-link-QT_UICIMPLPREFIX;, &cv-link-QT_UICIMPLSUFFIX;, &cv-link-QT_UISUFFIX;. +Sets: $QTDIR $QT_AUTOSCAN $QT_BINPATH $QT_CPPPATH $QT_LIB $QT_LIBPATH $QT_MOC $QT_MOCCXXPREFIX $QT_MOCCXXSUFFIX $QT_MOCFROMCXXCOM $QT_MOCFROMCXXFLAGS $QT_MOCFROMHCOM $QT_MOCFROMHFLAGS $QT_MOCHPREFIX $QT_MOCHSUFFIX $QT_UIC $QT_UICCOM $QT_UICDECLFLAGS $QT_UICDECLPREFIX $QT_UICDECLSUFFIX $QT_UICIMPLFLAGS $QT_UICIMPLPREFIX $QT_UICIMPLSUFFIX $QT_UISUFFIX rmic - - -Sets construction variables for the rmic utility. + +Sets construction variables for the rmic utility. -Sets: &cv-link-JAVACLASSSUFFIX;, &cv-link-RMIC;, &cv-link-RMICCOM;, &cv-link-RMICFLAGS;.Uses: &cv-link-RMICCOMSTR;. +Sets: $JAVACLASSSUFFIX $RMIC $RMICCOM $RMICFLAGS Uses: $RMICCOMSTR rpcgen - - + Sets construction variables for building with RPCGEN. -Sets: &cv-link-RPCGEN;, &cv-link-RPCGENCLIENTFLAGS;, &cv-link-RPCGENFLAGS;, &cv-link-RPCGENHEADERFLAGS;, &cv-link-RPCGENSERVICEFLAGS;, &cv-link-RPCGENXDRFLAGS;. +Sets: $RPCGEN $RPCGENCLIENTFLAGS $RPCGENFLAGS $RPCGENHEADERFLAGS $RPCGENSERVICEFLAGS $RPCGENXDRFLAGS sgiar - - + Sets construction variables for the SGI library archiver. -Sets: &cv-link-AR;, &cv-link-ARCOMSTR;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;, &cv-link-SHLINK;, &cv-link-SHLINKFLAGS;.Uses: &cv-link-ARCOMSTR;, &cv-link-SHLINKCOMSTR;. +Sets: $AR $ARCOMSTR $ARFLAGS $LIBPREFIX $LIBSUFFIX $SHLINK $SHLINKFLAGS Uses: $ARCOMSTR $SHLINKCOMSTR sgic++ - - + Sets construction variables for the SGI C++ compiler. -Sets: &cv-link-CXX;, &cv-link-CXXFLAGS;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;. +Sets: $CXX $CXXFLAGS $SHCXX $SHOBJSUFFIX sgicc - - + Sets construction variables for the SGI C compiler. -Sets: &cv-link-CXX;, &cv-link-SHOBJSUFFIX;. +Sets: $CXX $SHOBJSUFFIX sgilink - - + Sets construction variables for the SGI linker. -Sets: &cv-link-LINK;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;. +Sets: $LINK $RPATHPREFIX $RPATHSUFFIX $SHLINKFLAGS sunar - - + Sets construction variables for the Sun library archiver. -Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.Uses: &cv-link-ARCOMSTR;. +Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX Uses: $ARCOMSTR sunc++ - - + Sets construction variables for the Sun C++ compiler. -Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;. +Sets: $CXX $CXXVERSION $SHCXX $SHCXXFLAGS $SHOBJPREFIX $SHOBJSUFFIX suncc - - + Sets construction variables for the Sun C compiler. -Sets: &cv-link-CXX;, &cv-link-SHCCFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;. +Sets: $CXX $SHCCFLAGS $SHOBJPREFIX $SHOBJSUFFIX sunf77 - - -Set construction variables for the Sun f77 Fortran compiler. + +Set construction variables for the Sun f77 Fortran compiler. -Sets: &cv-link-F77;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. +Sets: $F77 $FORTRAN $SHF77 $SHF77FLAGS $SHFORTRAN $SHFORTRANFLAGS sunf90 - - -Set construction variables for the Sun f90 Fortran compiler. + +Set construction variables for the Sun f90 Fortran compiler. -Sets: &cv-link-F90;, &cv-link-FORTRAN;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. +Sets: $F90 $FORTRAN $SHF90 $SHF90FLAGS $SHFORTRAN $SHFORTRANFLAGS sunf95 - - -Set construction variables for the Sun f95 Fortran compiler. + +Set construction variables for the Sun f95 Fortran compiler. -Sets: &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. +Sets: $F95 $FORTRAN $SHF95 $SHF95FLAGS $SHFORTRAN $SHFORTRANFLAGS sunlink - - + Sets construction variables for the Sun linker. -Sets: &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;. +Sets: $RPATHPREFIX $RPATHSUFFIX $SHLINKFLAGS swig - - + Sets construction variables for the SWIG interface generator. -Sets: &cv-link-SWIG;, &cv-link-SWIGCFILESUFFIX;, &cv-link-SWIGCOM;, &cv-link-SWIGCXXFILESUFFIX;, &cv-link-SWIGDIRECTORSUFFIX;, &cv-link-SWIGFLAGS;, &cv-link-SWIGINCPREFIX;, &cv-link-SWIGINCSUFFIX;, &cv-link-SWIGPATH;, &cv-link-SWIGVERSION;, &cv-link-_SWIGINCFLAGS;.Uses: &cv-link-SWIGCOMSTR;. +Sets: $SWIG $SWIGCFILESUFFIX $SWIGCOM $SWIGCXXFILESUFFIX $SWIGDIRECTORSUFFIX $SWIGFLAGS $SWIGINCPREFIX $SWIGINCSUFFIX $SWIGPATH $SWIGVERSION $_SWIGINCFLAGS Uses: $SWIGCOMSTR tar - - -Sets construction variables for the tar archiver. + +Sets construction variables for the tar archiver. -Sets: &cv-link-TAR;, &cv-link-TARCOM;, &cv-link-TARFLAGS;, &cv-link-TARSUFFIX;.Uses: &cv-link-TARCOMSTR;. +Sets: $TAR $TARCOM $TARFLAGS $TARSUFFIX Uses: $TARCOMSTR tex - - + Sets construction variables for the TeX formatter and typesetter. -Sets: &cv-link-BIBTEX;, &cv-link-BIBTEXCOM;, &cv-link-BIBTEXFLAGS;, &cv-link-LATEX;, &cv-link-LATEXCOM;, &cv-link-LATEXFLAGS;, &cv-link-MAKEINDEX;, &cv-link-MAKEINDEXCOM;, &cv-link-MAKEINDEXFLAGS;, &cv-link-TEX;, &cv-link-TEXCOM;, &cv-link-TEXFLAGS;.Uses: &cv-link-BIBTEXCOMSTR;, &cv-link-LATEXCOMSTR;, &cv-link-MAKEINDEXCOMSTR;, &cv-link-TEXCOMSTR;. +Sets: $BIBTEX $BIBTEXCOM $BIBTEXFLAGS $LATEX $LATEXCOM $LATEXFLAGS $MAKEINDEX $MAKEINDEXCOM $MAKEINDEXFLAGS $TEX $TEXCOM $TEXFLAGS Uses: $BIBTEXCOMSTR $LATEXCOMSTR $MAKEINDEXCOMSTR $TEXCOMSTR textfile - - -Set construction variables for the Textfile and Substfile builders. + +Set construction variables for the Textfile and Substfile builders. -Sets: &cv-link-LINESEPARATOR;, &cv-link-SUBSTFILEPREFIX;, &cv-link-SUBSTFILESUFFIX;, &cv-link-TEXTFILEPREFIX;, &cv-link-TEXTFILESUFFIX;.Uses: &cv-link-SUBST_DICT;. +Sets: $LINESEPARATOR $SUBSTFILEPREFIX $SUBSTFILESUFFIX $TEXTFILEPREFIX $TEXTFILESUFFIX Uses: $SUBST_DICT tlib - - + Sets construction variables for the Borlan tib library archiver. -Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.Uses: &cv-link-ARCOMSTR;. +Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX Uses: $ARCOMSTR xgettext - - -This scons tool is a part of scons gettext toolset. It provides + +This scons tool is a part of scons gettext toolset. It provides scons interface to xgettext(1) program, which extracts internationalized messages from source code. The tool -provides POTUpdate builder to make PO +provides POTUpdate builder to make PO Template files. -Sets: &cv-link-POTSUFFIX;, &cv-link-POTUPDATE_ALIAS;, &cv-link-XGETTEXTCOM;, &cv-link-XGETTEXTCOMSTR;, &cv-link-XGETTEXTFLAGS;, &cv-link-XGETTEXTFROM;, &cv-link-XGETTEXTFROMPREFIX;, &cv-link-XGETTEXTFROMSUFFIX;, &cv-link-XGETTEXTPATH;, &cv-link-XGETTEXTPATHPREFIX;, &cv-link-XGETTEXTPATHSUFFIX;, &cv-link-_XGETTEXTDOMAIN;, &cv-link-_XGETTEXTFROMFLAGS;, &cv-link-_XGETTEXTPATHFLAGS;.Uses: &cv-link-POTDOMAIN;. +Sets: $POTSUFFIX $POTUPDATE_ALIAS $XGETTEXTCOM $XGETTEXTCOMSTR $XGETTEXTFLAGS $XGETTEXTFROM $XGETTEXTFROMPREFIX $XGETTEXTFROMSUFFIX $XGETTEXTPATH $XGETTEXTPATHPREFIX $XGETTEXTPATHSUFFIX $_XGETTEXTDOMAIN $_XGETTEXTFROMFLAGS $_XGETTEXTPATHFLAGS Uses: $POTDOMAIN yacc - - -Sets construction variables for the yacc parse generator. + +Sets construction variables for the yacc parse generator. -Sets: &cv-link-YACC;, &cv-link-YACCCOM;, &cv-link-YACCFLAGS;, &cv-link-YACCHFILESUFFIX;, &cv-link-YACCHXXFILESUFFIX;, &cv-link-YACCVCGFILESUFFIX;.Uses: &cv-link-YACCCOMSTR;. +Sets: $YACC $YACCCOM $YACCFLAGS $YACCHFILESUFFIX $YACCHXXFILESUFFIX $YACCVCGFILESUFFIX Uses: $YACCCOMSTR zip - - -Sets construction variables for the zip archiver. + +Sets construction variables for the zip archiver. -Sets: &cv-link-ZIP;, &cv-link-ZIPCOM;, &cv-link-ZIPCOMPRESSION;, &cv-link-ZIPFLAGS;, &cv-link-ZIPSUFFIX;.Uses: &cv-link-ZIPCOMSTR;. +Sets: $ZIP $ZIPCOM $ZIPCOMPRESSION $ZIPFLAGS $ZIPSUFFIX Uses: $ZIPCOMSTR diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 21e0b1f..30103ef 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -1,4 +1,3 @@ - %scons; @@ -12,125 +11,135 @@ %variables-mod; ]> - + - __LDMODULEVERSIONFLAGS - - -This construction variable automatically introduces $_LDMODULEVERSIONFLAGS -if $LDMODULEVERSION is set. Othervise it evaluates to an empty string. + + __LDMODULEVERSIONFLAGS + + +This construction variable automatically introduces $_LDMODULEVERSIONFLAGS +if $LDMODULEVERSION is set. Othervise it evaluates to an empty string. - __SHLIBVERSIONFLAGS - - -This construction variable automatically introduces $_SHLIBVERSIONFLAGS -if $SHLIBVERSION is set. Othervise it evaluates to an empty string. + + __SHLIBVERSIONFLAGS + + +This construction variable automatically introduces $_SHLIBVERSIONFLAGS +if $SHLIBVERSION is set. Othervise it evaluates to an empty string. - - _APPLELINK_COMPATIBILITY_VERSION - - - A macro (by default a generator function) used to create the linker flags to specify - apple's linker's -compatibility_version flag. - The default generator uses $APPLELINK_COMPATIBILITY_VERSION - and $APPLELINK_NO_COMPATIBILITY_VERSION and $SHLIBVERSION - to determine the correct flag. - - - - APPLELINK_COMPATIBILITY_VERSION - - + + APPLELINK_COMPATIBILITY_VERSION + + On Mac OS X this is used to set the linker flag: -compatibility_version - + The value is specified as X[.Y[.Z]] where X is between 1 and 65535, Y can be omitted or between 1 and - 255, Z can be omitted or between 1 and 255. This value will be derived from $SHLIBVERSION if + 255, Z can be omitted or between 1 and 255. This value will be derived from $SHLIBVERSION if not specified. The lowest digit will be dropped and replaced by a 0. - - If the $APPLELINK_NO_COMPATIBILITY_VERSION is set then no -compatibility_version will be + + If the $APPLELINK_NO_COMPATIBILITY_VERSION is set then no -compatibility_version will be output. - See MacOS's ld manpage for more details + See MacOS's ld manpage for more details - - _APPLELINK_CURRENT_VERSION - - - A macro (by default a generator function) used to create the linker flags to specify apple's linker's - -current_version flag. The default generator uses $APPLELINK_CURRENT_VERSION and - $APPLELINK_NO_CURRENT_VERSION and $SHLIBVERSION to determine the correct flag. + + + _APPLELINK_COMPATIBILITY_VERSION + + + A macro (by default a generator function) used to create the linker flags to specify + apple's linker's -compatibility_version flag. + The default generator uses $APPLELINK_COMPATIBILITY_VERSION + and $APPLELINK_NO_COMPATIBILITY_VERSION and $SHLIBVERSION + to determine the correct flag. - APPLELINK_CURRENT_VERSION - - + + APPLELINK_CURRENT_VERSION + + On Mac OS X this is used to set the linker flag: -current_version - + The value is specified as X[.Y[.Z]] where X is between 1 and 65535, Y can be omitted or between 1 and - 255, Z can be omitted or between 1 and 255. This value will be set to $SHLIBVERSION if not + 255, Z can be omitted or between 1 and 255. This value will be set to $SHLIBVERSION if not specified. - - If the $APPLELINK_NO_CURRENT_VERSION is set then no -current_version will be + + If the $APPLELINK_NO_CURRENT_VERSION is set then no -current_version will be output. - See MacOS's ld manpage for more details + See MacOS's ld manpage for more details + + + _APPLELINK_CURRENT_VERSION + + + A macro (by default a generator function) used to create the linker flags to specify apple's linker's + -current_version flag. The default generator uses $APPLELINK_CURRENT_VERSION and + $APPLELINK_NO_CURRENT_VERSION and $SHLIBVERSION to determine the correct flag. + + + - APPLELINK_NO_COMPATIBILITY_VERSION - - + + APPLELINK_NO_COMPATIBILITY_VERSION + + Set this to any True (1|True|non-empty string) value to disable adding -compatibility_version flag when generating versioned shared libraries. - - This overrides $APPLELINK_COMPATIBILITY_VERSION. + + This overrides $APPLELINK_COMPATIBILITY_VERSION. - APPLELINK_NO_CURRENT_VERSION - - + + APPLELINK_NO_CURRENT_VERSION + + Set this to any True (1|True|non-empty string) value to disable adding -current_version flag when generating versioned shared libraries. - - This overrides $APPLELINK_CURRENT_VERSION. + + This overrides $APPLELINK_CURRENT_VERSION. - AR - - + + AR + + The static library archiver. - ARCHITECTURE - - + + ARCHITECTURE + + Specifies the system architecture for which the package is being built. The default is the system architecture @@ -146,126 +155,138 @@ as well as forming part of the name of a generated RPM package file. - ARCOM - - + + ARCOM + + The command line used to generate a static library from object files. - ARCOMSTR - - -The string displayed when an object file -is generated from an assembly-language source file. -If this is not set, then $ARCOM (the command line) is displayed. + + ARCOMSTR + + +The string displayed when a static library is +generated from object files. +If this is not set, then $ARCOM (the command line) is displayed. - + env = Environment(ARCOMSTR = "Archiving $TARGET") - ARFLAGS - - + + ARFLAGS + + General options passed to the static library archiver. - AS - - + + AS + + The assembler. - ASCOM - - + + ASCOM + + The command line used to generate an object file from an assembly-language source file. - ASCOMSTR - - + + ASCOMSTR + + The string displayed when an object file is generated from an assembly-language source file. -If this is not set, then $ASCOM (the command line) is displayed. +If this is not set, then $ASCOM (the command line) is displayed. - + env = Environment(ASCOMSTR = "Assembling $TARGET") - ASFLAGS - - + + ASFLAGS + + General options passed to the assembler. - ASPPCOM - - + + ASPPCOM + + The command line used to assemble an assembly-language source file into an object file after first running the file through the C preprocessor. Any options specified -in the $ASFLAGS and $CPPFLAGS construction variables +in the $ASFLAGS and $CPPFLAGS construction variables are included on this command line. - ASPPCOMSTR - - + + ASPPCOMSTR + + The string displayed when an object file is generated from an assembly-language source file after first running the file through the C preprocessor. -If this is not set, then $ASPPCOM (the command line) is displayed. +If this is not set, then $ASPPCOM (the command line) is displayed. - + env = Environment(ASPPCOMSTR = "Assembling $TARGET") - ASPPFLAGS - - + + ASPPFLAGS + + General options when an assembling an assembly-language source file into an object file after first running the file through the C preprocessor. -The default is to use the value of $ASFLAGS. +The default is to use the value of $ASFLAGS. - BIBTEX - - + + BIBTEX + + The bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. - BIBTEXCOM - - + + BIBTEXCOM + + The command line used to call the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. @@ -273,32 +294,35 @@ typesetter. - BIBTEXCOMSTR - - + + BIBTEXCOMSTR + + The string displayed when generating a bibliography for TeX or LaTeX. -If this is not set, then $BIBTEXCOM (the command line) is displayed. +If this is not set, then $BIBTEXCOM (the command line) is displayed. - + env = Environment(BIBTEXCOMSTR = "Generating bibliography $TARGET") - BIBTEXFLAGS - - + + BIBTEXFLAGS + + General options passed to the bibliography generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. - BUILDERS - - + + BUILDERS + + A dictionary mapping the names of the builders available through this environment to underlying Builder objects. @@ -309,97 +333,105 @@ If you initialize this variable when an Environment is created: - + env = Environment(BUILDERS = {'NewBuilder' : foo}) - + the default Builders will no longer be available. To use a new Builder object in addition to the default Builders, add your new Builder object like this: - + env = Environment() env.Append(BUILDERS = {'NewBuilder' : foo}) - + or this: - + env = Environment() env['BUILDERS']['NewBuilder'] = foo - CC - - + + CC + + The C compiler. - CCCOM - - + + CCCOM + + The command line used to compile a C source file to a (static) object -file. Any options specified in the $CFLAGS, $CCFLAGS and -$CPPFLAGS construction variables are included on this command -line. +file. Any options specified in the $CFLAGS, $CCFLAGS and +$CPPFLAGS construction variables are included on this command line. +See also $SHCCCOM for compiling to shared objects. - CCCOMSTR - - -The string displayed when a C source file + + CCCOMSTR + + +If set, the string displayed when a C source file is compiled to a (static) object file. -If this is not set, then $CCCOM (the command line) is displayed. +If not set, then $CCCOM (the command line) is displayed. +See also $SHCCCOMSTR for compiling to shared objects. - + env = Environment(CCCOMSTR = "Compiling static object $TARGET") - CCFLAGS - - + + CCFLAGS + + General options that are passed to the C and C++ compilers. +See also $SHCCFLAGS for compiling to shared objects. - CCPCHFLAGS - - + + CCPCHFLAGS + + Options added to the compiler command line to support building with precompiled headers. The default value expands expands to the appropriate Microsoft Visual C++ command-line options -when the $PCH construction variable is set. +when the $PCH construction variable is set. - CCPDBFLAGS - - + + CCPDBFLAGS + + Options added to the compiler command line to support storing debugging information in a Microsoft Visual C++ PDB file. The default value expands expands to appropriate Microsoft Visual C++ command-line options -when the $PDB construction variable is set. +when the $PDB construction variable is set. - + The Visual C++ compiler option that SCons uses by default to generate PDB information is . This works correctly with parallel () builds @@ -412,31 +444,32 @@ link-time performance, although parallel builds will no longer work. - + You can generate PDB files with the -switch by overriding the default $CCPDBFLAGS variable as follows: +switch by overriding the default $CCPDBFLAGS variable as follows: - + env['CCPDBFLAGS'] = ['${(PDB and "/Zi /Fd%s" % File(PDB)) or ""}'] - + An alternative would be to use the to put the debugging information in a separate .pdb file for each object file by overriding -the $CCPDBFLAGS variable as follows: +the $CCPDBFLAGS variable as follows: - + env['CCPDBFLAGS'] = '/Zi /Fd${TARGET}.pdb' - CCVERSION - - + + CCVERSION + + The version number of the C compiler. This may or may not be set, depending on the specific C compiler being used. @@ -444,9 +477,10 @@ depending on the specific C compiler being used. - CFILESUFFIX - - + + CFILESUFFIX + + The suffix for C source files. This is used by the internal CFile builder when generating C files from Lex (.l) or YACC (.y) input files. @@ -462,17 +496,20 @@ as C files. - CFLAGS - - + + CFLAGS + + General options that are passed to the C compiler (C only; not C++). +See also $SHCFLAGS for compiling to shared objects. - CHANGE_SPECFILE - - + + CHANGE_SPECFILE + + A hook for modifying the file that controls the packaging build (the .spec for RPM, the control for Ipkg, @@ -483,9 +520,10 @@ after the SCons template for the file has been written. - CHANGED_SOURCES - - + + CHANGED_SOURCES + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -494,9 +532,10 @@ for more information). - CHANGED_TARGETS - - + + CHANGED_TARGETS + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -505,9 +544,10 @@ for more information). - CHANGELOG - - + + CHANGELOG + + The name of a file containing the change log text to be included in the package. This is included as the @@ -518,10 +558,11 @@ section of the RPM - _concat - - -A function used to produce variables like $_CPPINCFLAGS. It takes + + _concat + + +A function used to produce variables like $_CPPINCFLAGS. It takes four or five arguments: a prefix to concatenate onto each element, a list of elements, a suffix to concatenate onto each element, an environment @@ -529,15 +570,16 @@ for variable interpolation, and an optional function that will be called to transform the list before concatenation. - + env['_CPPINCFLAGS'] = '$( ${_concat(INCPREFIX, CPPPATH, INCSUFFIX, __env__, RDirs)} $)', - CONFIGUREDIR - - + + CONFIGUREDIR + + The name of the directory in which Configure context test files are written. The default is @@ -550,9 +592,10 @@ file. - CONFIGURELOG - - + + CONFIGURELOG + + The name of the Configure context log file. The default is config.log @@ -564,51 +607,53 @@ file. - _CPPDEFFLAGS - - + + _CPPDEFFLAGS + + An automatically-generated construction variable containing the C preprocessor command-line options to define values. -The value of $_CPPDEFFLAGS is created +The value of $_CPPDEFFLAGS is created by respectively prepending and appending -$CPPDEFPREFIX and $CPPDEFSUFFIX +$CPPDEFPREFIX and $CPPDEFSUFFIX to the beginning and end -of each definition in $CPPDEFINES. +of each definition in $CPPDEFINES. - CPPDEFINES - - + + CPPDEFINES + + A platform independent specification of C preprocessor definitions. The definitions will be added to command lines through the automatically-generated -$_CPPDEFFLAGS construction variable (see above), +$_CPPDEFFLAGS construction variable (see above), which is constructed according to -the type of value of $CPPDEFINES: +the type of value of $CPPDEFINES: - -If $CPPDEFINES is a string, + +If $CPPDEFINES is a string, the values of the -$CPPDEFPREFIX and $CPPDEFSUFFIX +$CPPDEFPREFIX and $CPPDEFSUFFIX construction variables will be respectively prepended and appended to the beginning and end -of each definition in $CPPDEFINES. +of each definition in $CPPDEFINES. - + # Will add -Dxyz to POSIX compiler command lines, # and /Dxyz to Microsoft Visual C++ command lines. env = Environment(CPPDEFINES='xyz') - -If $CPPDEFINES is a list, + +If $CPPDEFINES is a list, the values of the -$CPPDEFPREFIX and $CPPDEFSUFFIX +$CPPDEFPREFIX and $CPPDEFSUFFIX construction variables will be respectively prepended and appended to the beginning and end of each element in the list. @@ -617,16 +662,16 @@ then the first item is the name being defined and the second item is its value: - + # Will add -DB=2 -DA to POSIX compiler command lines, # and /DB=2 /DA to Microsoft Visual C++ command lines. env = Environment(CPPDEFINES=[('B', 2), 'A']) - -If $CPPDEFINES is a dictionary, + +If $CPPDEFINES is a dictionary, the values of the -$CPPDEFPREFIX and $CPPDEFSUFFIX +$CPPDEFPREFIX and $CPPDEFSUFFIX construction variables will be respectively prepended and appended to the beginning and end of each item from the dictionary. @@ -639,11 +684,11 @@ then the name is defined without an explicit value. Note that the resulting flags are sorted by keyword to ensure that the order of the options on the command line is consistent each time -scons +scons is run. - + # Will add -DA -DB=2 to POSIX compiler command lines, # and /DA /DB=2 to Microsoft Visual C++ command lines. env = Environment(CPPDEFINES={'B':2, 'A':None}) @@ -651,46 +696,49 @@ env = Environment(CPPDEFINES={'B':2, 'A':None}) - CPPDEFPREFIX - - + + CPPDEFPREFIX + + The prefix used to specify preprocessor definitions on the C compiler command line. This will be prepended to the beginning of each definition -in the $CPPDEFINES construction variable -when the $_CPPDEFFLAGS variable is automatically generated. +in the $CPPDEFINES construction variable +when the $_CPPDEFFLAGS variable is automatically generated. - CPPDEFSUFFIX - - + + CPPDEFSUFFIX + + The suffix used to specify preprocessor definitions on the C compiler command line. This will be appended to the end of each definition -in the $CPPDEFINES construction variable -when the $_CPPDEFFLAGS variable is automatically generated. +in the $CPPDEFINES construction variable +when the $_CPPDEFFLAGS variable is automatically generated. - CPPFLAGS - - + + CPPFLAGS + + User-specified C preprocessor options. These will be included in any command that uses the C preprocessor, including not just compilation of C and C++ source files -via the $CCCOM, -$SHCCCOM, -$CXXCOM and -$SHCXXCOM command lines, -but also the $FORTRANPPCOM, -$SHFORTRANPPCOM, -$F77PPCOM and -$SHF77PPCOM command lines +via the $CCCOM, +$SHCCCOM, +$CXXCOM and +$SHCXXCOM command lines, +but also the $FORTRANPPCOM, +$SHFORTRANPPCOM, +$F77PPCOM and +$SHF77PPCOM command lines used to compile a Fortran source file, -and the $ASPPCOM command line +and the $ASPPCOM command line used to assemble an assembly language source file, after first running each file through the C preprocessor. Note that this variable does @@ -698,30 +746,32 @@ Note that this variable does contain (or similar) include search path options -that scons generates automatically from $CPPPATH. -See $_CPPINCFLAGS, below, +that scons generates automatically from $CPPPATH. +See $_CPPINCFLAGS, below, for the variable that expands to those options. - _CPPINCFLAGS - - + + _CPPINCFLAGS + + An automatically-generated construction variable containing the C preprocessor command-line options for specifying directories to be searched for include files. -The value of $_CPPINCFLAGS is created -by respectively prepending and appending $INCPREFIX and $INCSUFFIX +The value of $_CPPINCFLAGS is created +by respectively prepending and appending $INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $CPPPATH. +of each directory in $CPPPATH. - CPPPATH - - + + CPPPATH + + The list of directories that the C preprocessor will search for include directories. The C/C++ implicit dependency scanner will search these directories for include files. Don't explicitly put include directory @@ -729,57 +779,58 @@ arguments in CCFLAGS or CXXFLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in CPPPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: - + env = Environment(CPPPATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(CPPPATH=include) - + The directory list will be added to command lines through the automatically-generated -$_CPPINCFLAGS +$_CPPINCFLAGS construction variable, which is constructed by respectively prepending and appending the value of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $CPPPATH. +of each directory in $CPPPATH. Any command lines you define that need the CPPPATH directory list should -include $_CPPINCFLAGS: +include $_CPPINCFLAGS: - + env = Environment(CCCOM="my_compiler $_CPPINCFLAGS -c -o $TARGET $SOURCE") - CPPSUFFIXES - - + + CPPSUFFIXES + + The list of suffixes of files that will be scanned for C preprocessor implicit dependencies (#include lines). The default list is: - + [".c", ".C", ".cxx", ".cpp", ".c++", ".cc", ".h", ".H", ".hxx", ".hpp", ".hh", ".F", ".fpp", ".FPP", @@ -789,42 +840,49 @@ The default list is: - CXX - - + + CXX + + The C++ compiler. +See also $SHCXX for compiling to shared objects.. - CXXCOM - - + + CXXCOM + + The command line used to compile a C++ source file to an object file. -Any options specified in the $CXXFLAGS and -$CPPFLAGS construction variables +Any options specified in the $CXXFLAGS and +$CPPFLAGS construction variables are included on this command line. +See also $SHCXXCOM for compiling to shared objects.. - CXXCOMSTR - - -The string displayed when a C++ source file + + CXXCOMSTR + + +If set, the string displayed when a C++ source file is compiled to a (static) object file. -If this is not set, then $CXXCOM (the command line) is displayed. +If not set, then $CXXCOM (the command line) is displayed. +See also $SHCXXCOMSTR for compiling to shared objects.. - + env = Environment(CXXCOMSTR = "Compiling static object $TARGET") - CXXFILESUFFIX - - + + CXXFILESUFFIX + + The suffix for C++ source files. This is used by the internal CXXFile builder when generating C++ files from Lex (.ll) or YACC (.yy) input files. @@ -849,21 +907,24 @@ as C++ files. - CXXFLAGS - - + + CXXFLAGS + + General options that are passed to the C++ compiler. -By default, this includes the value of $CCFLAGS, -so that setting $CCFLAGS affects both C and C++ compilation. +By default, this includes the value of $CCFLAGS, +so that setting $CCFLAGS affects both C and C++ compilation. If you want to add C++-specific flags, -you must set or override the value of $CXXFLAGS. +you must set or override the value of $CXXFLAGS. +See also $SHCXXFLAGS for compiling to shared objects.. - CXXVERSION - - + + CXXVERSION + + The version number of the C++ compiler. This may or may not be set, depending on the specific C++ compiler being used. @@ -871,51 +932,71 @@ depending on the specific C++ compiler being used. - DC - - + + DC + + The D compiler to use. +See also $SHDC for compiling to shared objects. - DCOM - - + + DCOM + + The command line used to compile a D file to an object file. -Any options specified in the $DFLAGS construction variable +Any options specified in the $DFLAGS construction variable is included on this command line. +See also $SHDCOM for compiling to shared objects. + + + + + + DCOMSTR + + +If set, the string displayed when a D source file +is compiled to a (static) object file. +If not set, then $DCOM (the command line) is displayed. +See also $SHDCOMSTR for compiling to shared objects. - DDEBUG - - + + DDEBUG + + List of debug tags to enable when compiling. - DDEBUGPREFIX - - + + DDEBUGPREFIX + + DDEBUGPREFIX. - DDEBUGSUFFIX - - + + DDEBUGSUFFIX + + DDEBUGSUFFIX. - DESCRIPTION - - + + DESCRIPTION + + A long description of the project being packaged. This is included in the relevant section of the file that controls the packaging build. @@ -923,9 +1004,10 @@ of the file that controls the packaging build. - DESCRIPTION_lang - - + + DESCRIPTION_lang + + A language-specific long description for the specified lang. This is used to populate a @@ -936,292 +1018,324 @@ section of an RPM - DFILESUFFIX - - + + DFILESUFFIX + + DFILESUFFIX. - DFLAGPREFIX - - + + DFLAGPREFIX + + DFLAGPREFIX. - DFLAGS - - + + DFLAGS + + General options that are passed to the D compiler. - DFLAGSUFFIX - - + + DFLAGSUFFIX + + DFLAGSUFFIX. - DINCPREFIX - - + + DINCPREFIX + + DINCPREFIX. - DINCSUFFIX - - + + DINCSUFFIX + + DLIBFLAGSUFFIX. - Dir - - -A function that converts a string -into a Dir instance relative to the target being built. - - - + + Dir + + A function that converts a string into a Dir instance relative to the target being built. - Dirs - - + + Dirs + + A function that converts a list of strings into a list of Dir instances relative to the target being built. - DLIB - - + + DLIB + + Name of the lib tool to use for D codes. - DLIBCOM - - + + DLIBCOM + + The command line to use when creating libraries. - DLIBDIRPREFIX - - + + DLIBDIRPREFIX + + DLIBLINKPREFIX. - DLIBDIRSUFFIX - - + + DLIBDIRSUFFIX + + DLIBLINKSUFFIX. - DLIBFLAGPREFIX - - + + DLIBFLAGPREFIX + + DLIBFLAGPREFIX. - DLIBFLAGSUFFIX - - + + DLIBFLAGSUFFIX + + DLIBFLAGSUFFIX. - DLIBLINKPREFIX - - + + DLIBLINKPREFIX + + DLIBLINKPREFIX. - DLIBLINKSUFFIX - - + + DLIBLINKSUFFIX + + DLIBLINKSUFFIX. - DLINK - - + + DLINK + + Name of the linker to use for linking systems including D sources. +See also $SHDLINK for linking shared objects. - DLINKCOM - - + + DLINKCOM + + The command line to use when linking systems including D sources. +See also $SHDLINKCOM for linking shared objects. - DLINKFLAGPREFIX - - + + DLINKFLAGPREFIX + + DLINKFLAGPREFIX. - DLINKFLAGS - - + + DLINKFLAGS + + List of linker flags. +See also $SHDLINKFLAGS for linking shared objects. - DLINKFLAGSUFFIX - - + + DLINKFLAGSUFFIX + + DLINKFLAGSUFFIX. - DOCBOOK_DEFAULT_XSL_EPUB - - -The default XSLT file for the DocbookEpub builder within the + + DOCBOOK_DEFAULT_XSL_EPUB + + +The default XSLT file for the DocbookEpub builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_HTML - - -The default XSLT file for the DocbookHtml builder within the + + DOCBOOK_DEFAULT_XSL_HTML + + +The default XSLT file for the DocbookHtml builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_HTMLCHUNKED - - -The default XSLT file for the DocbookHtmlChunked builder within the + + DOCBOOK_DEFAULT_XSL_HTMLCHUNKED + + +The default XSLT file for the DocbookHtmlChunked builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_HTMLHELP - - -The default XSLT file for the DocbookHtmlhelp builder within the + + DOCBOOK_DEFAULT_XSL_HTMLHELP + + +The default XSLT file for the DocbookHtmlhelp builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_MAN - - -The default XSLT file for the DocbookMan builder within the + + DOCBOOK_DEFAULT_XSL_MAN + + +The default XSLT file for the DocbookMan builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_PDF - - -The default XSLT file for the DocbookPdf builder within the + + DOCBOOK_DEFAULT_XSL_PDF + + +The default XSLT file for the DocbookPdf builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_SLIDESHTML - - -The default XSLT file for the DocbookSlidesHtml builder within the + + DOCBOOK_DEFAULT_XSL_SLIDESHTML + + +The default XSLT file for the DocbookSlidesHtml builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_DEFAULT_XSL_SLIDESPDF - - -The default XSLT file for the DocbookSlidesPdf builder within the + + DOCBOOK_DEFAULT_XSL_SLIDESPDF + + +The default XSLT file for the DocbookSlidesPdf builder within the current environment, if no other XSLT gets specified via keyword. - DOCBOOK_FOP - - + + DOCBOOK_FOP + + The path to the PDF renderer fop or xep, if one of them is installed (fop gets checked first). - DOCBOOK_FOPCOM - - + + DOCBOOK_FOPCOM + + The full command-line for the PDF renderer fop or xep. - DOCBOOK_FOPCOMSTR - - + + DOCBOOK_FOPCOMSTR + + The string displayed when a renderer like fop or xep is used to create PDF output from an XML file. - DOCBOOK_FOPFLAGS - - + + DOCBOOK_FOPFLAGS + + Additonal command-line flags for the PDF renderer fop or xep. - DOCBOOK_XMLLINT - - + + DOCBOOK_XMLLINT + + The path to the external executable xmllint, if it's installed. Note, that this is only used as last fallback for resolving XIncludes, if no libxml2 or lxml Python binding can be imported @@ -1230,36 +1344,40 @@ in the current system. - DOCBOOK_XMLLINTCOM - - + + DOCBOOK_XMLLINTCOM + + The full command-line for the external executable xmllint. - DOCBOOK_XMLLINTCOMSTR - - + + DOCBOOK_XMLLINTCOMSTR + + The string displayed when xmllint is used to resolve XIncludes for a given XML file. - DOCBOOK_XMLLINTFLAGS - - + + DOCBOOK_XMLLINTFLAGS + + Additonal command-line flags for the external executable xmllint. - DOCBOOK_XSLTPROC - - + + DOCBOOK_XSLTPROC + + The path to the external executable xsltproc (or saxon, xalan), if one of them is installed. @@ -1269,9 +1387,10 @@ no libxml2 or lxml Python binding can be imported in the current system. - DOCBOOK_XSLTPROCCOM - - + + DOCBOOK_XSLTPROCCOM + + The full command-line for the external executable xsltproc (or saxon, xalan). @@ -1279,18 +1398,20 @@ The full command-line for the external executable - DOCBOOK_XSLTPROCCOMSTR - - + + DOCBOOK_XSLTPROCCOMSTR + + The string displayed when xsltproc is used to transform an XML file via a given XSLT stylesheet. - DOCBOOK_XSLTPROCFLAGS - - + + DOCBOOK_XSLTPROCFLAGS + + Additonal command-line flags for the external executable xsltproc (or saxon, xalan). @@ -1298,9 +1419,10 @@ Additonal command-line flags for the external executable - DOCBOOK_XSLTPROCPARAMS - - + + DOCBOOK_XSLTPROCPARAMS + + Additonal parameters that are not intended for the XSLT processor executable, but the XSL processing itself. By default, they get appended at the end of the command line for saxon and saxon-xslt, respectively. @@ -1308,150 +1430,161 @@ for saxon and saxon-xslt, respectively. - DPATH - - + + DPATH + + List of paths to search for import modules. - DRPATHPREFIX - - + + DRPATHPREFIX + + DRPATHPREFIX. - DRPATHSUFFIX - - + + DRPATHSUFFIX + + DRPATHSUFFIX. - DShLibSonameGenerator - - + + DShLibSonameGenerator + + DShLibSonameGenerator. - DSUFFIXES - - + + DSUFFIXES + + The list of suffixes of files that will be scanned for imported D package files. -The default list is: +The default list is ['.d']. - - -['.d'] - - DVERPREFIX - - + + DVERPREFIX + + DVERPREFIX. - DVERSIONS - - + + DVERSIONS + + List of version tags to enable when compiling. - DVERSUFFIX - - + + DVERSUFFIX + + DVERSUFFIX. - DVIPDF - - + + DVIPDF + + The TeX DVI file to PDF file converter. - DVIPDFCOM - - + + DVIPDFCOM + + The command line used to convert TeX DVI files into a PDF file. - DVIPDFCOMSTR - - + + DVIPDFCOMSTR + + The string displayed when a TeX DVI file is converted into a PDF file. -If this is not set, then $DVIPDFCOM (the command line) is displayed. +If this is not set, then $DVIPDFCOM (the command line) is displayed. - DVIPDFFLAGS - - + + DVIPDFFLAGS + + General options passed to the TeX DVI file to PDF file converter. - DVIPS - - + + DVIPS + + The TeX DVI file to PostScript converter. - DVIPSFLAGS - - + + DVIPSFLAGS + + General options passed to the TeX DVI file to PostScript converter. - ENV - - + + ENV + + A dictionary of environment variables to use when invoking commands. When -$ENV is used in a command all list +$ENV is used in a command all list values will be joined using the path separator and any other non-string values will simply be coerced to a string. Note that, by default, -scons +scons does not propagate the environment in force when you execute -scons +scons to the commands used to build target files. This is so that builds will be guaranteed repeatable regardless of the environment variables set at the time -scons +scons is invoked. - + If you want to propagate your environment variables to the commands executed @@ -1459,12 +1592,12 @@ to build target files, you must do so explicitly: - + import os env = Environment(ENV = os.environ) - + Note that you can choose only to propagate certain environment variables. A common example is @@ -1472,21 +1605,22 @@ the system PATH environment variable, so that -scons +scons uses the same utilities as the invoking shell (or other process): - + import os env = Environment(ENV = {'PATH' : os.environ['PATH']}) - ESCAPE - - + + ESCAPE + + A function that will be called to escape shell special characters in command lines. The function should take one argument: the command line string to escape; and should return the escaped command line. @@ -1494,69 +1628,74 @@ string to escape; and should return the escaped command line. - F03 - - + + F03 + + The Fortran 03 compiler. -You should normally set the $FORTRAN variable, +You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $F03 if you need to use a specific compiler +You only need to set $F03 if you need to use a specific compiler or compiler version for Fortran 03 files. - F03COM - - + + F03COM + + The command line used to compile a Fortran 03 source file to an object file. -You only need to set $F03COM if you need to use a specific +You only need to set $F03COM if you need to use a specific command line for Fortran 03 files. -You should normally set the $FORTRANCOM variable, +You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions. - F03COMSTR - - -The string displayed when a Fortran 03 source file + + F03COMSTR + + +If set, the string displayed when a Fortran 03 source file is compiled to an object file. -If this is not set, then $F03COM or $FORTRANCOM +If not set, then $F03COM or $FORTRANCOM (the command line) is displayed. - F03FILESUFFIXES - - + + F03FILESUFFIXES + + The list of file extensions for which the F03 dialect will be used. By default, this is ['.f03'] - F03FLAGS - - + + F03FLAGS + + General user-specified options that are passed to the Fortran 03 compiler. Note that this variable does not contain (or similar) include search path options -that scons generates automatically from $F03PATH. +that scons generates automatically from $F03PATH. See -$_F03INCFLAGS +$_F03INCFLAGS below, for the variable that expands to those options. -You only need to set $F03FLAGS if you need to define specific +You only need to set $F03FLAGS if you need to define specific user options for Fortran 03 files. -You should normally set the $FORTRANFLAGS variable, +You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1564,177 +1703,187 @@ for all Fortran versions. - _F03INCFLAGS - - + + _F03INCFLAGS + + An automatically-generated construction variable containing the Fortran 03 compiler command-line options for specifying directories to be searched for include files. -The value of $_F03INCFLAGS is created -by appending $INCPREFIX and $INCSUFFIX +The value of $_F03INCFLAGS is created +by appending $INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $F03PATH. +of each directory in $F03PATH. - F03PATH - - + + F03PATH + + The list of directories that the Fortran 03 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 $F03FLAGS because the result will be non-portable +arguments in $F03FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in $F03PATH will be looked-up relative to the SConscript +directory names in $F03PATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: -You only need to set $F03PATH if you need to define a specific +You only need to set $F03PATH if you need to define a specific include path for Fortran 03 files. -You should normally set the $FORTRANPATH variable, +You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions. - + env = Environment(F03PATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(F03PATH=include) - + The directory list will be added to command lines through the automatically-generated -$_F03INCFLAGS +$_F03INCFLAGS construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $F03PATH. +of each directory in $F03PATH. Any command lines you define that need the F03PATH directory list should -include $_F03INCFLAGS: +include $_F03INCFLAGS: - + env = Environment(F03COM="my_compiler $_F03INCFLAGS -c -o $TARGET $SOURCE") - F03PPCOM - - + + F03PPCOM + + The command line used to compile a Fortran 03 source file to an object file after first running the file through the C preprocessor. -Any options specified in the $F03FLAGS and $CPPFLAGS construction variables +Any options specified in the $F03FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $F03PPCOM if you need to use a specific +You only need to set $F03PPCOM if you need to use a specific C-preprocessor command line for Fortran 03 files. -You should normally set the $FORTRANPPCOM variable, +You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - F03PPCOMSTR - - -The string displayed when a Fortran 03 source file + + F03PPCOMSTR + + +If set, the string displayed when a Fortran 03 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then $F03PPCOM or $FORTRANPPCOM +If not set, then $F03PPCOM or $FORTRANPPCOM (the command line) is displayed. - F03PPFILESUFFIXES - - + + F03PPFILESUFFIXES + + The list of file extensions for which the compilation + preprocessor pass for F03 dialect will be used. By default, this is empty - F08 - - + + F08 + + The Fortran 08 compiler. -You should normally set the $FORTRAN variable, +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 +You only need to set $F08 if you need to use a specific compiler or compiler version for Fortran 08 files. - F08COM - - + + 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 +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, +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 + + F08COMSTR + + +If set, the string displayed when a Fortran 08 source file is compiled to an object file. -If this is not set, then $F08COM or $FORTRANCOM +If not set, then $F08COM or $FORTRANCOM (the command line) is displayed. - F08FILESUFFIXES - - + + F08FILESUFFIXES + + The list of file extensions for which the F08 dialect will be used. By default, this is ['.f08'] - F08FLAGS - - + + 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. +that scons generates automatically from $F08PATH. See -$_F08INCFLAGS +$_F08INCFLAGS below, for the variable that expands to those options. -You only need to set $F08FLAGS if you need to define specific +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, +You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1742,177 +1891,187 @@ for all Fortran versions. - _F08INCFLAGS - - + + _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 +The value of $_F08INCFLAGS is created +by appending $INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $F08PATH. +of each directory in $F08PATH. - 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 +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 names in $F08PATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +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 +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, +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() +Dir() function: - + include = Dir('include') env = Environment(F08PATH=include) - + The directory list will be added to command lines through the automatically-generated -$_F08INCFLAGS +$_F08INCFLAGS construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $F08PATH. +of each directory in $F08PATH. Any command lines you define that need the F08PATH directory list should -include $_F08INCFLAGS: +include $_F08INCFLAGS: - + env = Environment(F08COM="my_compiler $_F08INCFLAGS -c -o $TARGET $SOURCE") - F08PPCOM - - + + 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 +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 +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, +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 + + F08PPCOMSTR + + +If set, 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 +If not set, then $F08PPCOM or $FORTRANPPCOM (the command line) is displayed. - F08PPFILESUFFIXES - - + + F08PPFILESUFFIXES + + The list of file extensions for which the compilation + preprocessor pass for F08 dialect will be used. By default, this is empty - F77 - - + + F77 + + The Fortran 77 compiler. -You should normally set the $FORTRAN variable, +You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $F77 if you need to use a specific compiler +You only need to set $F77 if you need to use a specific compiler or compiler version for Fortran 77 files. - F77COM - - + + F77COM + + The command line used to compile a Fortran 77 source file to an object file. -You only need to set $F77COM if you need to use a specific +You only need to set $F77COM if you need to use a specific command line for Fortran 77 files. -You should normally set the $FORTRANCOM variable, +You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions. - F77COMSTR - - -The string displayed when a Fortran 77 source file + + F77COMSTR + + +If set, the string displayed when a Fortran 77 source file is compiled to an object file. -If this is not set, then $F77COM or $FORTRANCOM +If not set, then $F77COM or $FORTRANCOM (the command line) is displayed. - F77FILESUFFIXES - - + + F77FILESUFFIXES + + The list of file extensions for which the F77 dialect will be used. By default, this is ['.f77'] - F77FLAGS - - + + F77FLAGS + + General user-specified options that are passed to the Fortran 77 compiler. Note that this variable does not contain (or similar) include search path options -that scons generates automatically from $F77PATH. +that scons generates automatically from $F77PATH. See -$_F77INCFLAGS +$_F77INCFLAGS below, for the variable that expands to those options. -You only need to set $F77FLAGS if you need to define specific +You only need to set $F77FLAGS if you need to define specific user options for Fortran 77 files. -You should normally set the $FORTRANFLAGS variable, +You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1920,177 +2079,187 @@ for all Fortran versions. - _F77INCFLAGS - - + + _F77INCFLAGS + + An automatically-generated construction variable containing the Fortran 77 compiler command-line options for specifying directories to be searched for include files. -The value of $_F77INCFLAGS is created -by appending $INCPREFIX and $INCSUFFIX +The value of $_F77INCFLAGS is created +by appending $INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $F77PATH. +of each directory in $F77PATH. - F77PATH - - + + F77PATH + + The list of directories that the Fortran 77 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 $F77FLAGS because the result will be non-portable +arguments in $F77FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in $F77PATH will be looked-up relative to the SConscript +directory names in $F77PATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: -You only need to set $F77PATH if you need to define a specific +You only need to set $F77PATH if you need to define a specific include path for Fortran 77 files. -You should normally set the $FORTRANPATH variable, +You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions. - + env = Environment(F77PATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(F77PATH=include) - + The directory list will be added to command lines through the automatically-generated -$_F77INCFLAGS +$_F77INCFLAGS construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $F77PATH. +of each directory in $F77PATH. Any command lines you define that need the F77PATH directory list should -include $_F77INCFLAGS: +include $_F77INCFLAGS: - + env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE") - F77PPCOM - - + + F77PPCOM + + The command line used to compile a Fortran 77 source file to an object file after first running the file through the C preprocessor. -Any options specified in the $F77FLAGS and $CPPFLAGS construction variables +Any options specified in the $F77FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $F77PPCOM if you need to use a specific +You only need to set $F77PPCOM if you need to use a specific C-preprocessor command line for Fortran 77 files. -You should normally set the $FORTRANPPCOM variable, +You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - F77PPCOMSTR - - -The string displayed when a Fortran 77 source file + + F77PPCOMSTR + + +If set, the string displayed when a Fortran 77 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then $F77PPCOM or $FORTRANPPCOM +If not set, then $F77PPCOM or $FORTRANPPCOM (the command line) is displayed. - F77PPFILESUFFIXES - - + + F77PPFILESUFFIXES + + The list of file extensions for which the compilation + preprocessor pass for F77 dialect will be used. By default, this is empty - F90 - - + + F90 + + The Fortran 90 compiler. -You should normally set the $FORTRAN variable, +You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $F90 if you need to use a specific compiler +You only need to set $F90 if you need to use a specific compiler or compiler version for Fortran 90 files. - F90COM - - + + F90COM + + The command line used to compile a Fortran 90 source file to an object file. -You only need to set $F90COM if you need to use a specific +You only need to set $F90COM if you need to use a specific command line for Fortran 90 files. -You should normally set the $FORTRANCOM variable, +You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions. - F90COMSTR - - -The string displayed when a Fortran 90 source file + + F90COMSTR + + +If set, the string displayed when a Fortran 90 source file is compiled to an object file. -If this is not set, then $F90COM or $FORTRANCOM +If not set, then $F90COM or $FORTRANCOM (the command line) is displayed. - F90FILESUFFIXES - - + + F90FILESUFFIXES + + The list of file extensions for which the F90 dialect will be used. By default, this is ['.f90'] - F90FLAGS - - + + F90FLAGS + + General user-specified options that are passed to the Fortran 90 compiler. Note that this variable does not contain (or similar) include search path options -that scons generates automatically from $F90PATH. +that scons generates automatically from $F90PATH. See -$_F90INCFLAGS +$_F90INCFLAGS below, for the variable that expands to those options. -You only need to set $F90FLAGS if you need to define specific +You only need to set $F90FLAGS if you need to define specific user options for Fortran 90 files. -You should normally set the $FORTRANFLAGS variable, +You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2098,176 +2267,186 @@ for all Fortran versions. - _F90INCFLAGS - - + + _F90INCFLAGS + + An automatically-generated construction variable containing the Fortran 90 compiler command-line options for specifying directories to be searched for include files. -The value of $_F90INCFLAGS is created -by appending $INCPREFIX and $INCSUFFIX +The value of $_F90INCFLAGS is created +by appending $INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $F90PATH. +of each directory in $F90PATH. - F90PATH - - + + F90PATH + + The list of directories that the Fortran 90 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 $F90FLAGS because the result will be non-portable +arguments in $F90FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in $F90PATH will be looked-up relative to the SConscript +directory names in $F90PATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: -You only need to set $F90PATH if you need to define a specific +You only need to set $F90PATH if you need to define a specific include path for Fortran 90 files. -You should normally set the $FORTRANPATH variable, +You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions. - + env = Environment(F90PATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(F90PATH=include) - + The directory list will be added to command lines through the automatically-generated -$_F90INCFLAGS +$_F90INCFLAGS construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $F90PATH. +of each directory in $F90PATH. Any command lines you define that need the F90PATH directory list should -include $_F90INCFLAGS: +include $_F90INCFLAGS: - + env = Environment(F90COM="my_compiler $_F90INCFLAGS -c -o $TARGET $SOURCE") - F90PPCOM - - + + F90PPCOM + + The command line used to compile a Fortran 90 source file to an object file after first running the file through the C preprocessor. -Any options specified in the $F90FLAGS and $CPPFLAGS construction variables +Any options specified in the $F90FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $F90PPCOM if you need to use a specific +You only need to set $F90PPCOM if you need to use a specific C-preprocessor command line for Fortran 90 files. -You should normally set the $FORTRANPPCOM variable, +You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - F90PPCOMSTR - - -The string displayed when a Fortran 90 source file + + F90PPCOMSTR + + +If set, the string displayed when a Fortran 90 source file is compiled after first running the file through the C preprocessor. -If this is not set, then $F90PPCOM or $FORTRANPPCOM +If not set, then $F90PPCOM or $FORTRANPPCOM (the command line) is displayed. - F90PPFILESUFFIXES - - + + F90PPFILESUFFIXES + + The list of file extensions for which the compilation + preprocessor pass for F90 dialect will be used. By default, this is empty - F95 - - + + F95 + + The Fortran 95 compiler. -You should normally set the $FORTRAN variable, +You should normally set the $FORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $F95 if you need to use a specific compiler +You only need to set $F95 if you need to use a specific compiler or compiler version for Fortran 95 files. - F95COM - - + + F95COM + + The command line used to compile a Fortran 95 source file to an object file. -You only need to set $F95COM if you need to use a specific +You only need to set $F95COM if you need to use a specific command line for Fortran 95 files. -You should normally set the $FORTRANCOM variable, +You should normally set the $FORTRANCOM variable, which specifies the default command line for all Fortran versions. - F95COMSTR - - -The string displayed when a Fortran 95 source file + + F95COMSTR + + +If set, the string displayed when a Fortran 95 source file is compiled to an object file. -If this is not set, then $F95COM or $FORTRANCOM +If not set, then $F95COM or $FORTRANCOM (the command line) is displayed. - F95FILESUFFIXES - - + + F95FILESUFFIXES + + The list of file extensions for which the F95 dialect will be used. By default, this is ['.f95'] - F95FLAGS - - + + F95FLAGS + + General user-specified options that are passed to the Fortran 95 compiler. Note that this variable does not contain (or similar) include search path options -that scons generates automatically from $F95PATH. +that scons generates automatically from $F95PATH. See -$_F95INCFLAGS +$_F95INCFLAGS below, for the variable that expands to those options. -You only need to set $F95FLAGS if you need to define specific +You only need to set $F95FLAGS if you need to define specific user options for Fortran 95 files. -You should normally set the $FORTRANFLAGS variable, +You should normally set the $FORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2275,209 +2454,217 @@ for all Fortran versions. - _F95INCFLAGS - - + + _F95INCFLAGS + + An automatically-generated construction variable containing the Fortran 95 compiler command-line options for specifying directories to be searched for include files. -The value of $_F95INCFLAGS is created -by appending $INCPREFIX and $INCSUFFIX +The value of $_F95INCFLAGS is created +by appending $INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $F95PATH. +of each directory in $F95PATH. - F95PATH - - + + F95PATH + + The list of directories that the Fortran 95 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 $F95FLAGS because the result will be non-portable +arguments in $F95FLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: -directory names in $F95PATH will be looked-up relative to the SConscript +directory names in $F95PATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: -You only need to set $F95PATH if you need to define a specific +You only need to set $F95PATH if you need to define a specific include path for Fortran 95 files. -You should normally set the $FORTRANPATH variable, +You should normally set the $FORTRANPATH variable, which specifies the include path for the default Fortran compiler for all Fortran versions. - + env = Environment(F95PATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(F95PATH=include) - + The directory list will be added to command lines through the automatically-generated -$_F95INCFLAGS +$_F95INCFLAGS construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $F95PATH. +of each directory in $F95PATH. Any command lines you define that need the F95PATH directory list should -include $_F95INCFLAGS: +include $_F95INCFLAGS: - + env = Environment(F95COM="my_compiler $_F95INCFLAGS -c -o $TARGET $SOURCE") - F95PPCOM - - + + F95PPCOM + + The command line used to compile a Fortran 95 source file to an object file after first running the file through the C preprocessor. -Any options specified in the $F95FLAGS and $CPPFLAGS construction variables +Any options specified in the $F95FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $F95PPCOM if you need to use a specific +You only need to set $F95PPCOM if you need to use a specific C-preprocessor command line for Fortran 95 files. -You should normally set the $FORTRANPPCOM variable, +You should normally set the $FORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - F95PPCOMSTR - - -The string displayed when a Fortran 95 source file + + F95PPCOMSTR + + +If set, the string displayed when a Fortran 95 source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then $F95PPCOM or $FORTRANPPCOM +If not set, then $F95PPCOM or $FORTRANPPCOM (the command line) is displayed. - F95PPFILESUFFIXES - - + + F95PPFILESUFFIXES + + The list of file extensions for which the compilation + preprocessor pass for F95 dialect will be used. By default, this is empty - File - - -A function that converts a string into a File instance relative to the -target being built. - - - + + File + + A function that converts a string into a File instance relative to the target being built. - FORTRAN - - + + FORTRAN + + The default Fortran compiler for all versions of Fortran. - FORTRANCOM - - + + FORTRANCOM + + The command line used to compile a Fortran source file to an object file. By default, any options specified -in the $FORTRANFLAGS, -$CPPFLAGS, -$_CPPDEFFLAGS, -$_FORTRANMODFLAG, and -$_FORTRANINCFLAGS construction variables +in the $FORTRANFLAGS, +$CPPFLAGS, +$_CPPDEFFLAGS, +$_FORTRANMODFLAG, and +$_FORTRANINCFLAGS construction variables are included on this command line. - FORTRANCOMSTR - - -The string displayed when a Fortran source file + + FORTRANCOMSTR + + +If set, the string displayed when a Fortran source file is compiled to an object file. -If this is not set, then $FORTRANCOM +If not set, then $FORTRANCOM (the command line) is displayed. - FORTRANFILESUFFIXES - - + + FORTRANFILESUFFIXES + + The list of file extensions for which the FORTRAN dialect will be used. By default, this is ['.f', '.for', '.ftn'] - FORTRANFLAGS - - + + FORTRANFLAGS + + General user-specified options that are passed to the Fortran compiler. Note that this variable does not contain (or similar) include or module search path options -that scons generates automatically from $FORTRANPATH. +that scons generates automatically from $FORTRANPATH. See -$_FORTRANINCFLAGS and $_FORTRANMODFLAG, +$_FORTRANINCFLAGS and $_FORTRANMODFLAG, below, for the variables that expand those options. - _FORTRANINCFLAGS - - + + _FORTRANINCFLAGS + + An automatically-generated construction variable containing the Fortran compiler command-line options for specifying directories to be searched for include files and module files. -The value of $_FORTRANINCFLAGS is created +The value of $_FORTRANINCFLAGS is created by respectively prepending and appending -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX to the beginning and end -of each directory in $FORTRANPATH. +of each directory in $FORTRANPATH. - FORTRANMODDIR - - + + FORTRANMODDIR + + Directory location where the Fortran compiler should place any module files it generates. This variable is empty, by default. Some Fortran compilers will internally append this directory in the search path @@ -2486,49 +2673,53 @@ for module files, as well. - FORTRANMODDIRPREFIX - - + + FORTRANMODDIRPREFIX + + The prefix used to specify a module directory on the Fortran compiler command line. This will be prepended to the beginning of the directory -in the $FORTRANMODDIR construction variables -when the $_FORTRANMODFLAG variables is automatically generated. +in the $FORTRANMODDIR construction variables +when the $_FORTRANMODFLAG variables is automatically generated. - FORTRANMODDIRSUFFIX - - + + FORTRANMODDIRSUFFIX + + The suffix used to specify a module directory on the Fortran compiler command line. This will be appended to the end of the directory -in the $FORTRANMODDIR construction variables -when the $_FORTRANMODFLAG variables is automatically generated. +in the $FORTRANMODDIR construction variables +when the $_FORTRANMODFLAG variables is automatically generated. - _FORTRANMODFLAG - - + + _FORTRANMODFLAG + + An automatically-generated construction variable containing the Fortran compiler command-line option for specifying the directory location where the Fortran compiler should place any module files that happen to get generated during compilation. -The value of $_FORTRANMODFLAG is created +The value of $_FORTRANMODFLAG is created by respectively prepending and appending -$FORTRANMODDIRPREFIX and $FORTRANMODDIRSUFFIX -to the beginning and end of the directory in $FORTRANMODDIR. +$FORTRANMODDIRPREFIX and $FORTRANMODDIRSUFFIX +to the beginning and end of the directory in $FORTRANMODDIR. - FORTRANMODPREFIX - - + + FORTRANMODPREFIX + + The module file prefix used by the Fortran compiler. SCons assumes that the Fortran compiler follows the quasi-standard naming convention for module files of @@ -2541,9 +2732,10 @@ module file name as scons attempts to resolve dependencies. - FORTRANMODSUFFIX - - + + FORTRANMODSUFFIX + + The module file suffix used by the Fortran compiler. SCons assumes that the Fortran compiler follows the quasi-standard naming convention for module files of @@ -2556,9 +2748,10 @@ module file name as scons attempts to resolve dependencies. - FORTRANPATH - - + + FORTRANPATH + + The list of directories that the Fortran compiler will search for include files and (for some compilers) module files. The Fortran implicit dependency scanner will search these directories for include files (but @@ -2568,234 +2761,249 @@ include directory arguments in FORTRANFLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in FORTRANPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: - + env = Environment(FORTRANPATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(FORTRANPATH=include) - + The directory list will be added to command lines through the automatically-generated -$_FORTRANINCFLAGS +$_FORTRANINCFLAGS construction variable, which is constructed by respectively prepending and appending the values of the -$INCPREFIX and $INCSUFFIX +$INCPREFIX and $INCSUFFIX construction variables to the beginning and end -of each directory in $FORTRANPATH. +of each directory in $FORTRANPATH. Any command lines you define that need the FORTRANPATH directory list should -include $_FORTRANINCFLAGS: +include $_FORTRANINCFLAGS: - + env = Environment(FORTRANCOM="my_compiler $_FORTRANINCFLAGS -c -o $TARGET $SOURCE") - FORTRANPPCOM - - + + FORTRANPPCOM + + The command line used to compile a Fortran source file to an object file after first running the file through the C preprocessor. -By default, any options specified in the $FORTRANFLAGS, -$CPPFLAGS, -$_CPPDEFFLAGS, -$_FORTRANMODFLAG, and -$_FORTRANINCFLAGS +By default, any options specified in the $FORTRANFLAGS, +$CPPFLAGS, +$_CPPDEFFLAGS, +$_FORTRANMODFLAG, and +$_FORTRANINCFLAGS construction variables are included on this command line. - FORTRANPPCOMSTR - - -The string displayed when a Fortran source file + + FORTRANPPCOMSTR + + +If set, the string displayed when a Fortran source file is compiled to an object file after first running the file through the C preprocessor. -If this is not set, then $FORTRANPPCOM +If not set, then $FORTRANPPCOM (the command line) is displayed. - FORTRANPPFILESUFFIXES - - + + FORTRANPPFILESUFFIXES + + The list of file extensions for which the compilation + preprocessor pass for FORTRAN dialect will be used. By default, this is ['.fpp', '.FPP'] - FORTRANSUFFIXES - - + + FORTRANSUFFIXES + + The list of suffixes of files that will be scanned for Fortran implicit dependencies (INCLUDE lines and USE statements). The default list is: - + [".f", ".F", ".for", ".FOR", ".ftn", ".FTN", ".fpp", ".FPP", ".f77", ".F77", ".f90", ".F90", ".f95", ".F95"] - FRAMEWORKPATH - - + + FRAMEWORKPATH + + On Mac OS X with gcc, a list containing the paths to search for frameworks. Used by the compiler to find framework-style includes like #include <Fmwk/Header.h>. Used by the linker to find user-specified frameworks when linking (see - $FRAMEWORKS). + $FRAMEWORKS). For example: - - env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') + +env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') - + will add - - ... -Fmyframeworkdir + +... -Fmyframeworkdir - + to the compiler and linker command lines. - _FRAMEWORKPATH - - + + _FRAMEWORKPATH + + On Mac OS X with gcc, an automatically-generated construction variable containing the linker command-line options corresponding to - $FRAMEWORKPATH. + $FRAMEWORKPATH. - FRAMEWORKPATHPREFIX - - + + FRAMEWORKPATHPREFIX + + On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries. - (see $FRAMEWORKPATH). + (see $FRAMEWORKPATH). The default value is . - FRAMEWORKPREFIX - - + + FRAMEWORKPREFIX + + On Mac OS X with gcc, the prefix to be used for linking in frameworks - (see $FRAMEWORKS). + (see $FRAMEWORKS). The default value is . - - _FRAMEWORKS - - - On Mac OS X with gcc, - an automatically-generated construction variable - containing the linker command-line options - for linking with FRAMEWORKS. - - - - FRAMEWORKS - - + + FRAMEWORKS + + On Mac OS X with gcc, a list of the framework names to be linked into a program or shared library or bundle. The default value is the empty list. For example: - - env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration')) + +env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration')) + + + _FRAMEWORKS + + + On Mac OS X with gcc, + an automatically-generated construction variable + containing the linker command-line options + for linking with FRAMEWORKS. + + + - FRAMEWORKSFLAGS - - + + FRAMEWORKSFLAGS + + On Mac OS X with gcc, general user-supplied frameworks options to be added at the end of a command line building a loadable module. (This has been largely superseded by - the $FRAMEWORKPATH, $FRAMEWORKPATHPREFIX, - $FRAMEWORKPREFIX and $FRAMEWORKS variables + the $FRAMEWORKPATH, $FRAMEWORKPATHPREFIX, + $FRAMEWORKPREFIX and $FRAMEWORKS variables described above.) - GS - - + + GS + + The Ghostscript program used, e.g. to convert PostScript to PDF files. - GSCOM - - + + GSCOM + + The full Ghostscript command line used for the conversion process. Its default value is $GS $GSFLAGS -sOutputFile=$TARGET $SOURCES. - GSCOMSTR - - + + GSCOMSTR + + The string displayed when Ghostscript is called for the conversion process. -If this is not set (the default), then $GSCOM (the command line) is displayed. +If this is not set (the default), then $GSCOM (the command line) is displayed. - GSFLAGS - - + + GSFLAGS + + General options passed to the Ghostscript program, when converting PostScript to PDF files for example. Its default value is -dNOPAUSE -dBATCH -sDEVICE=pdfwrite @@ -2803,9 +3011,10 @@ is -dNOPAUSE -dBATCH -sDEVICE=pdfwrite - HOST_ARCH - - + + 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. @@ -2813,8 +3022,7 @@ is -dNOPAUSE -dBATCH -sDEVICE=pdfwrite 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 on the python you are using. @@ -2822,20 +3030,21 @@ This variable must be passed as an argument to the Environment() constructor; setting it later has no effect. - -Valid values are the same as for $TARGET_ARCH. + +Valid values are the same as for $TARGET_ARCH. - + This is currently only used on Windows, but in the future it will be used on other OSes as well. - HOST_OS - - + + HOST_OS + + The name of the host operating system used to create the Environment. If a platform is specified when creating the Environment, then that Platform's logic will handle setting this value. @@ -2846,137 +3055,203 @@ used on other OSes as well. - IDLSUFFIXES - - + + IDLSUFFIXES + + The list of suffixes of files that will be scanned for IDL implicit dependencies (#include or import lines). The default list is: - + [".idl", ".IDL"] - IMPLIBNOVERSIONSYMLINKS - - -Used to override $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS when + + IMPLIBNOVERSIONSYMLINKS + + +Used to override $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS when creating versioned import library for a shared library/loadable module. If not defined, -then $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS is used to determine +then $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS is used to determine whether to disable symlink generation or not. - IMPLIBPREFIX - - + + IMPLIBPREFIX + + The prefix used for import library names. For example, cygwin uses import libraries (libfoo.dll.a) in pair with dynamic libraries -(cygfoo.dll). The cyglink linker sets -$IMPLIBPREFIX to 'lib' and $SHLIBPREFIX +(cygfoo.dll). The cyglink linker sets +$IMPLIBPREFIX to 'lib' and $SHLIBPREFIX to 'cyg'. - IMPLIBSUFFIX - - + + IMPLIBSUFFIX + + The suffix used for import library names. For example, cygwin uses import libraries (libfoo.dll.a) in pair with dynamic libraries -(cygfoo.dll). The cyglink linker sets -$IMPLIBSUFFIX to '.dll.a' and $SHLIBSUFFIX +(cygfoo.dll). The cyglink linker sets +$IMPLIBSUFFIX to '.dll.a' and $SHLIBSUFFIX to '.dll'. - IMPLIBVERSION - - -Used to override $SHLIBVERSION/$LDMODULEVERSION when + + IMPLIBVERSION + + +Used to override $SHLIBVERSION/$LDMODULEVERSION when generating versioned import library for a shared library/loadable module. If -undefined, the $SHLIBVERSION/$LDMODULEVERSION is used to +undefined, the $SHLIBVERSION/$LDMODULEVERSION is used to determine the version of versioned import library. - IMPLICIT_COMMAND_DEPENDENCIES - - + + IMPLICIT_COMMAND_DEPENDENCIES + + Controls whether or not SCons will add implicit dependencies for the commands executed to build targets. - + By default, SCons will add to each target an implicit dependency on the command -represented by the first argument on any -command line it executes. +represented by the first argument of any +command line it executes (which is typically +the command itself). By setting such +a dependency, SCons can determine that +a target should be rebuilt if the command changes, +such as when a compiler is upgraded to a new version. The specific file for the dependency is found by searching the PATH variable in the -ENV -environment used to execute the command. - - - -If the construction variable -$IMPLICIT_COMMAND_DEPENDENCIES -is set to a false value -(None, -False, -0, +ENV dictionary +in the construction environment used to execute the command. +The default is the same as +setting the construction variable +$IMPLICIT_COMMAND_DEPENDENCIES +to a True-like value (true, +yes, +or 1 - but not a number +greater than one, as that has a different meaning). + + + +Action strings can be segmented by the +use of an AND operator, &&. +In a segemented string, each segment is a separate +command line, these are run +sequentially until one fails or the entire +sequence has been executed. If an +action string is segmented, then the selected +behavior of $IMPLICIT_COMMAND_DEPENDENCIES +is applied to each segment. + + + +If $IMPLICIT_COMMAND_DEPENDENCIES +is set to a False-like value +(none, +false, +no, +0, etc.), then the implicit dependency will not be added to the targets -built with that construction environment. +built with that construction environment. + + + +If $IMPLICIT_COMMAND_DEPENDENCIES +is set to 2 or higher, +then that number of arguments in the command line +will be scanned for relative or absolute paths. +If any are present, they will be added as +implicit dependencies to the targets built +with that construction environment. +The first argument in the command line will be +searched for using the PATH +variable in the ENV dictionary +in the construction environment used to execute the command. +The other arguments will only be found if they +are absolute paths or valid paths relative +to the working directory. + + + +If $IMPLICIT_COMMAND_DEPENDENCIES +is set to all, +then all arguments in the command line will be +scanned for relative or absolute paths. +If any are present, they will be added as +implicit dependencies to the targets built +with that construction environment. +The first argument in the command line will be +searched for using the PATH +variable in the ENV dictionary +in the construction environment used to execute the command. +The other arguments will only be found if they +are absolute paths or valid paths relative +to the working directory. - -env = Environment(IMPLICIT_COMMAND_DEPENDENCIES = 0) + +env = Environment(IMPLICIT_COMMAND_DEPENDENCIES=False) - INCPREFIX - - + + INCPREFIX + + The prefix used to specify an include directory on the C compiler command line. This will be prepended to the beginning of each directory -in the $CPPPATH and $FORTRANPATH construction variables -when the $_CPPINCFLAGS and $_FORTRANINCFLAGS +in the $CPPPATH and $FORTRANPATH construction variables +when the $_CPPINCFLAGS and $_FORTRANINCFLAGS variables are automatically generated. - INCSUFFIX - - + + INCSUFFIX + + The suffix used to specify an include directory on the C compiler command line. This will be appended to the end of each directory -in the $CPPPATH and $FORTRANPATH construction variables -when the $_CPPINCFLAGS and $_FORTRANINCFLAGS +in the $CPPPATH and $FORTRANPATH construction variables +when the $_CPPINCFLAGS and $_FORTRANINCFLAGS variables are automatically generated. - INSTALL - - + + INSTALL + + A function to be called to install a file into a destination file name. The default function copies the file into the destination @@ -2985,11 +3260,11 @@ to match the source file's). The function takes the following arguments: - + def install(dest, source, env): - + dest is the path name of the destination file. source @@ -3002,22 +3277,24 @@ in force for this file installation. - INSTALLSTR - - + + INSTALLSTR + + The string displayed when a file is installed into a destination file name. The default is: - + Install file: "$SOURCE" as "$TARGET" - INTEL_C_COMPILER_VERSION - - + + INTEL_C_COMPILER_VERSION + + Set by the "intelc" Tool to the major version number of the Intel C compiler selected for use. @@ -3025,28 +3302,19 @@ selected for use. - JAR - - -The Java archive tool. - - - + + JAR + + The Java archive tool. - JARCHDIR - - -The directory to which the Java archive tool should change -(using the - -option). - - - + + JARCHDIR + + The directory to which the Java archive tool should change (using the @@ -3055,54 +3323,34 @@ option). - JARCOM - - -The command line used to call the Java archive tool. - - - + + JARCOM + + The command line used to call the Java archive tool. - JARCOMSTR - - -The string displayed when the Java archive tool -is called -If this is not set, then $JARCOM (the command line) is displayed. - - - -env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") - - - + + JARCOMSTR + + 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. - -env = Environment(JARCOMSTR = "JARchiving $SOURCES into $TARGET") + +env = Environment(JARCOMSTR="JARchiving $SOURCES into $TARGET") - JARFLAGS - - -General options passed to the Java archive tool. -By default this is set to - -to create the necessary -jar -file. - - - + + JARFLAGS + + General options passed to the Java archive tool. By default this is set to @@ -3113,15 +3361,10 @@ file. - JARSUFFIX - - -The suffix for Java archives: -.jar -by default. - - - + + JARSUFFIX + + The suffix for Java archives: .jar by default. @@ -3129,12 +3372,13 @@ by default. - JAVABOOTCLASSPATH - - + + JAVABOOTCLASSPATH + + Specifies the list of directories that will be added to the - javac command line + javac command line via the option. The individual directory names will be separated by the operating system's path separate character @@ -3145,52 +3389,57 @@ by default. - JAVAC - - + + JAVAC + + The Java compiler. - JAVACCOM - - + + JAVACCOM + + The command line used to compile a directory tree containing Java source files to corresponding Java class files. - Any options specified in the $JAVACFLAGS construction variable + Any options specified in the $JAVACFLAGS construction variable are included on this command line. - JAVACCOMSTR - - + + JAVACCOMSTR + + The string displayed when compiling a directory tree of Java source files to corresponding Java class files. - If this is not set, then $JAVACCOM (the command line) is displayed. + If this is not set, then $JAVACCOM (the command line) is displayed. - - env = Environment(JAVACCOMSTR = "Compiling class files $TARGETS from $SOURCES") + +env = Environment(JAVACCOMSTR="Compiling class files $TARGETS from $SOURCES") - JAVACFLAGS - - + + JAVACFLAGS + + General options that are passed to the Java compiler. - JAVACLASSDIR - - + + JAVACLASSDIR + + The directory in which Java class files may be found. This is stripped from the beginning of any Java .class file names supplied to the @@ -3200,15 +3449,16 @@ by default. - JAVACLASSPATH - - + + JAVACLASSPATH + + Specifies the list of directories that will be searched for Java .class file. The directories in this list will be added to the - javac and javah command lines + javac and javah command lines via the option. The individual directory names will be separated by the operating system's path separate character @@ -3217,20 +3467,21 @@ by default. on Windows). - + Note that this currently just adds the specified directory via the option. - SCons does not currently search the - $JAVACLASSPATH directories for dependency + SCons does not currently search the + $JAVACLASSPATH directories for dependency .class files. - JAVACLASSSUFFIX - - + + JAVACLASSSUFFIX + + The suffix for Java class files; .class by default. @@ -3238,65 +3489,71 @@ by default. - JAVAH - - + + JAVAH + + The Java generator for C header and stub files. - JAVAHCOM - - + + JAVAHCOM + + The command line used to generate C header and stub files from Java classes. -Any options specified in the $JAVAHFLAGS construction variable +Any options specified in the $JAVAHFLAGS construction variable are included on this command line. - JAVAHCOMSTR - - + + JAVAHCOMSTR + + The string displayed when C header and stub files are generated from Java classes. -If this is not set, then $JAVAHCOM (the command line) is displayed. +If this is not set, then $JAVAHCOM (the command line) is displayed. - -env = Environment(JAVAHCOMSTR = "Generating header/stub file(s) $TARGETS from $SOURCES") + +env = Environment(JAVAHCOMSTR="Generating header/stub file(s) $TARGETS from $SOURCES") - JAVAHFLAGS - - + + JAVAHFLAGS + + General options passed to the C header and stub file generator for Java classes. - JAVAINCLUDES - - + + JAVAINCLUDES + + Include path for Java header files (such as jni.h) - JAVASOURCEPATH - - + + JAVASOURCEPATH + + Specifies the list of directories that will be searched for input .java file. The directories in this list will be added to the - javac command line + javac command line via the option. The individual directory names will be separated by the operating system's path separate character @@ -3305,20 +3562,21 @@ for Java classes. on Windows). - + Note that this currently just adds the specified directory via the option. - SCons does not currently search the - $JAVASOURCEPATH directories for dependency + SCons does not currently search the + $JAVASOURCEPATH directories for dependency .java files. - JAVASUFFIX - - + + JAVASUFFIX + + The suffix for Java files; .java by default. @@ -3326,77 +3584,83 @@ for Java classes. - JAVAVERSION - - - Specifies the Java version being used by the Java builder. + + JAVAVERSION + + + Specifies the Java version being used by the Java builder. This is not currently used to select one version of the Java compiler vs. another. Instead, you should set this to specify the version of Java - supported by your javac compiler. + supported by your javac compiler. The default is 1.4. - + This is sometimes necessary because Java 1.5 changed the file names that are created for nested anonymous inner classes, which can cause a mismatch with the files - that SCons expects will be generated by the javac compiler. - Setting $JAVAVERSION to + that SCons expects will be generated by the javac compiler. + Setting $JAVAVERSION to 1.5 (or 1.6, as appropriate) - can make SCons realize that a Java 1.5 or 1.6 + can make SCons realize that a Java 1.5 or 1.6 build is actually up to date. - LATEX - - + + LATEX + + The LaTeX structured formatter and typesetter. - LATEXCOM - - + + LATEXCOM + + The command line used to call the LaTeX structured formatter and typesetter. - LATEXCOMSTR - - + + LATEXCOMSTR + + The string displayed when calling the LaTeX structured formatter and typesetter. -If this is not set, then $LATEXCOM (the command line) is displayed. +If this is not set, then $LATEXCOM (the command line) is displayed. - + env = Environment(LATEXCOMSTR = "Building $TARGET from LaTeX input $SOURCES") - LATEXFLAGS - - + + LATEXFLAGS + + General options passed to the LaTeX structured formatter and typesetter. - LATEXRETRIES - - + + LATEXRETRIES + + The maximum number of times that LaTeX will be re-run if the .log -generated by the $LATEXCOM command +generated by the $LATEXCOM command indicates that there are undefined references. The default is to try to resolve undefined references by re-running LaTeX up to three times. @@ -3404,92 +3668,113 @@ by re-running LaTeX up to three times. - LATEXSUFFIXES - - + + LATEXSUFFIXES + + The list of suffixes of files that will be scanned for LaTeX implicit dependencies (\include or \import files). The default list is: - + [".tex", ".ltx", ".latex"] - LDMODULE - - + + LDMODULE + + The linker for building loadable modules. -By default, this is the same as $SHLINK. +By default, this is the same as $SHLINK. - LDMODULECOM - - + + LDMODULECOM + + The command line for building loadable modules. -On Mac OS X, this uses the $LDMODULE, -$LDMODULEFLAGS and -$FRAMEWORKSFLAGS variables. -On other systems, this is the same as $SHLINK. +On Mac OS X, this uses the $LDMODULE, +$LDMODULEFLAGS and +$FRAMEWORKSFLAGS variables. +On other systems, this is the same as $SHLINK. - LDMODULECOMSTR - - -The string displayed when building loadable modules. -If this is not set, then $LDMODULECOM (the command line) is displayed. + + LDMODULECOMSTR + + +If set, the string displayed when building loadable modules. +If not set, then $LDMODULECOM (the command line) is displayed. + + + + + + LDMODULEEMITTER + + +Contains the emitter specification for the +LoadableModule builder. +The manpage section "Builder Objects" contains +general information on specifying emitters. - LDMODULEFLAGS - - + + LDMODULEFLAGS + + General user options passed to the linker for building loadable modules. - LDMODULENOVERSIONSYMLINKS - - -Instructs the LoadableModule builder to not automatically create symlinks + + LDMODULENOVERSIONSYMLINKS + + +Instructs the LoadableModule builder to not automatically create symlinks for versioned modules. Defaults to $SHLIBNOVERSIONSYMLINKS - LDMODULEPREFIX - - + + LDMODULEPREFIX + + The prefix used for loadable module file names. On Mac OS X, this is null; on other systems, this is -the same as $SHLIBPREFIX. +the same as $SHLIBPREFIX. - _LDMODULESONAME - - + + _LDMODULESONAME + + A macro that automatically generates loadable module's SONAME based on $TARGET, -$LDMODULEVERSION and $LDMODULESUFFIX. Used by LoadableModule builder -when the linker tool supports SONAME (e.g. gnulink). +$LDMODULEVERSION and $LDMODULESUFFIX. Used by LoadableModule builder +when the linker tool supports SONAME (e.g. gnulink). - LDMODULESUFFIX - - + + LDMODULESUFFIX + + The suffix used for loadable module file names. On Mac OS X, this is null; on other systems, this is @@ -3498,227 +3783,244 @@ the same as $SHLIBSUFFIX. - LDMODULEVERSION - - + + LDMODULEVERSION + + When this construction variable is defined, a versioned loadable module -is created by LoadableModule builder. This activates the -$_LDMODULEVERSIONFLAGS and thus modifies the $LDMODULECOM as +is created by LoadableModule builder. This activates the +$_LDMODULEVERSIONFLAGS and thus modifies the $LDMODULECOM as required, adds the version number to the library name, and creates the symlinks -that are needed. $LDMODULEVERSION versions should exist in the same -format as $SHLIBVERSION. - - - - - LDMODULEVERSIONFLAGS - - -Extra flags added to $LDMODULECOM when building versioned -LoadableModule. These flags are only used when $LDMODULEVERSION is -set. +that are needed. $LDMODULEVERSION versions should exist in the same +format as $SHLIBVERSION. - _LDMODULEVERSIONFLAGS - - -This macro automatically introduces extra flags to $LDMODULECOM when -building versioned LoadableModule (that is when -$LDMODULEVERSION is set). _LDMODULEVERSIONFLAGS -usually adds $SHLIBVERSIONFLAGS and some extra dynamically generated + + _LDMODULEVERSIONFLAGS + + +This macro automatically introduces extra flags to $LDMODULECOM when +building versioned LoadableModule (that is when +$LDMODULEVERSION is set). _LDMODULEVERSIONFLAGS +usually adds $SHLIBVERSIONFLAGS and some extra dynamically generated options (such as -Wl,-soname=$_LDMODULESONAME). It is unused by plain (unversioned) loadable modules. + + + LDMODULEVERSIONFLAGS + + +Extra flags added to $LDMODULECOM when building versioned +LoadableModule. These flags are only used when $LDMODULEVERSION is +set. + + + - LEX - - + + LEX + + The lexical analyzer generator. - LEXCOM - - + + LEXCOM + + The command line used to call the lexical analyzer generator to generate a source file. - LEXCOMSTR - - + + LEXCOMSTR + + The string displayed when generating a source file using the lexical analyzer generator. -If this is not set, then $LEXCOM (the command line) is displayed. +If this is not set, then $LEXCOM (the command line) is displayed. - + env = Environment(LEXCOMSTR = "Lex'ing $TARGET from $SOURCES") - LEXFLAGS - - + + LEXFLAGS + + General options passed to the lexical analyzer generator. - LEXUNISTD - - + + LEXUNISTD + + Used only on windows environments to set a lex flag to prevent 'unistd.h' from being included. The default value is '--nounistd'. - _LIBDIRFLAGS - - + + _LIBDIRFLAGS + + An automatically-generated construction variable containing the linker command-line options for specifying directories to be searched for library. -The value of $_LIBDIRFLAGS is created -by respectively prepending and appending $LIBDIRPREFIX and $LIBDIRSUFFIX +The value of $_LIBDIRFLAGS is created +by respectively prepending and appending $LIBDIRPREFIX and $LIBDIRSUFFIX to the beginning and end -of each directory in $LIBPATH. +of each directory in $LIBPATH. - LIBDIRPREFIX - - + + LIBDIRPREFIX + + The prefix used to specify a library directory on the linker command line. This will be prepended to the beginning of each directory -in the $LIBPATH construction variable -when the $_LIBDIRFLAGS variable is automatically generated. +in the $LIBPATH construction variable +when the $_LIBDIRFLAGS variable is automatically generated. - LIBDIRSUFFIX - - + + LIBDIRSUFFIX + + The suffix used to specify a library directory on the linker command line. This will be appended to the end of each directory -in the $LIBPATH construction variable -when the $_LIBDIRFLAGS variable is automatically generated. +in the $LIBPATH construction variable +when the $_LIBDIRFLAGS variable is automatically generated. - LIBEMITTER - - + + LIBEMITTER + + Contains the emitter specification for the -StaticLibrary builder. +StaticLibrary builder. The manpage section "Builder Objects" contains general information on specifying emitters. - _LIBFLAGS - - + + _LIBFLAGS + + An automatically-generated construction variable containing the linker command-line options for specifying libraries to be linked with the resulting target. -The value of $_LIBFLAGS is created -by respectively prepending and appending $LIBLINKPREFIX and $LIBLINKSUFFIX +The value of $_LIBFLAGS is created +by respectively prepending and appending $LIBLINKPREFIX and $LIBLINKSUFFIX to the beginning and end -of each filename in $LIBS. +of each filename in $LIBS. - LIBLINKPREFIX - - + + LIBLINKPREFIX + + The prefix used to specify a library to link on the linker command line. This will be prepended to the beginning of each library -in the $LIBS construction variable -when the $_LIBFLAGS variable is automatically generated. +in the $LIBS construction variable +when the $_LIBFLAGS variable is automatically generated. - LIBLINKSUFFIX - - + + LIBLINKSUFFIX + + The suffix used to specify a library to link on the linker command line. This will be appended to the end of each library -in the $LIBS construction variable -when the $_LIBFLAGS variable is automatically generated. +in the $LIBS construction variable +when the $_LIBFLAGS variable is automatically generated. - LIBPATH - - + + LIBPATH + + The list of directories that will be searched for libraries. The implicit dependency scanner will search these directories for include files. Don't explicitly put include directory -arguments in $LINKFLAGS or $SHLINKFLAGS +arguments in $LINKFLAGS or $SHLINKFLAGS because the result will be non-portable and the directories will not be searched by the dependency scanner. Note: directory names in LIBPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: - + env = Environment(LIBPATH='#/libs') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + libs = Dir('libs') env = Environment(LIBPATH=libs) - + The directory list will be added to command lines through the automatically-generated -$_LIBDIRFLAGS +$_LIBDIRFLAGS construction variable, which is constructed by respectively prepending and appending the values of the -$LIBDIRPREFIX and $LIBDIRSUFFIX +$LIBDIRPREFIX and $LIBDIRSUFFIX construction variables to the beginning and end -of each directory in $LIBPATH. +of each directory in $LIBPATH. Any command lines you define that need the LIBPATH directory list should -include $_LIBDIRFLAGS: +include $_LIBDIRFLAGS: - + env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE") - LIBPREFIX - - + + LIBPREFIX + + The prefix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), @@ -3729,75 +4031,78 @@ to reflect the names of the libraries they create. - LIBPREFIXES - - + + LIBPREFIXES + + A list of all legal prefixes for library file names. When searching for library dependencies, SCons will look for files with these prefixes, the base library name, -and suffixes in the $LIBSUFFIXES list. +and suffixes in the $LIBSUFFIXES list. - LIBS - - + + LIBS + + A list of one or more libraries that will be linked with any executable programs created by this environment. - + The library list will be added to command lines through the automatically-generated -$_LIBFLAGS +$_LIBFLAGS construction variable, which is constructed by respectively prepending and appending the values of the -$LIBLINKPREFIX and $LIBLINKSUFFIX +$LIBLINKPREFIX and $LIBLINKSUFFIX construction variables to the beginning and end -of each filename in $LIBS. +of each filename in $LIBS. Any command lines you define that need the LIBS library list should -include $_LIBFLAGS: +include $_LIBFLAGS: - + env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE") - + If you add a File object to the -$LIBS +$LIBS list, the name of that file will be added to -$_LIBFLAGS, +$_LIBFLAGS, and thus the link line, as is, without -$LIBLINKPREFIX +$LIBLINKPREFIX or -$LIBLINKSUFFIX. +$LIBLINKSUFFIX. For example: - + env.Append(LIBS=File('/tmp/mylib.so')) - + In all cases, scons will add dependencies from the executable program to all the libraries in this list. - LIBSUFFIX - - + + LIBSUFFIX + + The suffix used for (static) library file names. A default value is set for each platform (posix, win32, os2, etc.), @@ -3808,21 +4113,23 @@ to reflect the names of the libraries they create. - LIBSUFFIXES - - + + LIBSUFFIXES + + A list of all legal suffixes for library file names. When searching for library dependencies, -SCons will look for files with prefixes, in the $LIBPREFIXES list, +SCons will look for files with prefixes, in the $LIBPREFIXES list, the base library name, and these suffixes. - LICENSE - - + + LICENSE + + The abbreviated name, preferably the SPDX code, of the license under which this project is released (GPL-3.0, LGPL-2.1, BSD-2-Clause etc.). See http://www.opensource.org/licenses/alphabetical @@ -3831,24 +4138,26 @@ for a list of license names and SPDX codes. - LINESEPARATOR - - -The separator used by the Substfile and Textfile builders. + + LINESEPARATOR + + +The separator used by the Substfile and Textfile builders. This value is used between sources when constructing the target. It defaults to the current system line separator. - LINGUAS_FILE - - -The $LINGUAS_FILE defines file(s) containing list of additional linguas -to be processed by POInit, POUpdate or MOFiles -builders. It also affects Translate builder. If the variable contains -a string, it defines name of the list file. The $LINGUAS_FILE may be a -list of file names as well. If $LINGUAS_FILE is set to + + LINGUAS_FILE + + +The $LINGUAS_FILE defines file(s) containing list of additional linguas +to be processed by POInit, POUpdate or MOFiles +builders. It also affects Translate builder. If the variable contains +a string, it defines name of the list file. The $LINGUAS_FILE may be a +list of file names as well. If $LINGUAS_FILE is set to True (or non-zero numeric value), the list will be read from default file named LINGUAS. @@ -3857,107 +4166,121 @@ default file named - LINK - - + + LINK + + The linker. +See also $SHLINK for linking shared objects. - LINKCOM - - + + LINKCOM + + The command line used to link object files into an executable. +See also $SHLINKCOM for linking shared objects. - LINKCOMSTR - - -The string displayed when object files + + LINKCOMSTR + + +If set, the string displayed when object files are linked into an executable. -If this is not set, then $LINKCOM (the command line) is displayed. +If not set, then $LINKCOM (the command line) is displayed. +See also $SHLINKCOMSTR. for linking shared objects. - + env = Environment(LINKCOMSTR = "Linking $TARGET") - LINKFLAGS - - + + LINKFLAGS + + General user options passed to the linker. Note that this variable should not contain -(or similar) options for linking with the libraries listed in $LIBS, +(or similar) options for linking with the libraries listed in $LIBS, nor (or similar) library search path options -that scons generates automatically from $LIBPATH. +that scons generates automatically from $LIBPATH. See -$_LIBFLAGS +$_LIBFLAGS above, for the variable that expands to library-link options, and -$_LIBDIRFLAGS +$_LIBDIRFLAGS above, for the variable that expands to library search path options. +See also $SHLINKFLAGS. for linking shared objects. - M4 - - + + M4 + + The M4 macro preprocessor. - M4COM - - + + M4COM + + The command line used to pass files through the M4 macro preprocessor. - M4COMSTR - - + + M4COMSTR + + The string displayed when a file is passed through the M4 macro preprocessor. -If this is not set, then $M4COM (the command line) is displayed. +If this is not set, then $M4COM (the command line) is displayed. - M4FLAGS - - + + M4FLAGS + + General options passed to the M4 macro preprocessor. - MAKEINDEX - - + + MAKEINDEX + + The makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. - MAKEINDEXCOM - - + + MAKEINDEXCOM + + The command line used to call the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. @@ -3965,29 +4288,32 @@ typesetter. - MAKEINDEXCOMSTR - - + + MAKEINDEXCOMSTR + + The string displayed when calling the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. -If this is not set, then $MAKEINDEXCOM (the command line) is displayed. +If this is not set, then $MAKEINDEXCOM (the command line) is displayed. - MAKEINDEXFLAGS - - + + MAKEINDEXFLAGS + + General options passed to the makeindex generator for the TeX formatter and typesetter and the LaTeX structured formatter and typesetter. - MAXLINELENGTH - - + + MAXLINELENGTH + + The maximum number of characters allowed on an external command line. On Win32 systems, link lines longer than this many characters @@ -3996,179 +4322,198 @@ are linked via a temporary file name. - MIDL - - + + MIDL + + The Microsoft IDL compiler. - MIDLCOM - - + + MIDLCOM + + The command line used to pass files to the Microsoft IDL compiler. - MIDLCOMSTR - - + + MIDLCOMSTR + + The string displayed when the Microsoft IDL compiler is called. -If this is not set, then $MIDLCOM (the command line) is displayed. +If this is not set, then $MIDLCOM (the command line) is displayed. - MIDLFLAGS - - + + MIDLFLAGS + + General options passed to the Microsoft IDL compiler. - MOSUFFIX - - + + MOSUFFIX + + Suffix used for MO files (default: '.mo'). -See msgfmt tool and MOFiles builder. +See msgfmt tool and MOFiles builder. - MSGFMT - - + + MSGFMT + + Absolute path to msgfmt(1) binary, found by Detect(). -See msgfmt tool and MOFiles builder. +See msgfmt tool and MOFiles builder. - MSGFMTCOM - - + + MSGFMTCOM + + Complete command line to run msgfmt(1) program. -See msgfmt tool and MOFiles builder. +See msgfmt tool and MOFiles builder. - MSGFMTCOMSTR - - + + MSGFMTCOMSTR + + String to display when msgfmt(1) is invoked -(default: '', which means ``print $MSGFMTCOM''). -See msgfmt tool and MOFiles builder. +(default: '', which means ``print $MSGFMTCOM''). +See msgfmt tool and MOFiles builder. - MSGFMTFLAGS - - + + MSGFMTFLAGS + + Additional flags to msgfmt(1). -See msgfmt tool and MOFiles builder. +See msgfmt tool and MOFiles builder. - MSGINIT - - + + MSGINIT + + Path to msginit(1) program (found via Detect()). -See msginit tool and POInit builder. +See msginit tool and POInit builder. - MSGINITCOM - - + + MSGINITCOM + + Complete command line to run msginit(1) program. -See msginit tool and POInit builder. +See msginit tool and POInit builder. - MSGINITCOMSTR - - + + MSGINITCOMSTR + + String to display when msginit(1) is invoked -(default: '', which means ``print $MSGINITCOM''). -See msginit tool and POInit builder. +(default: '', which means ``print $MSGINITCOM''). +See msginit tool and POInit builder. - MSGINITFLAGS - - + + MSGINITFLAGS + + List of additional flags to msginit(1) (default: []). -See msginit tool and POInit builder. +See msginit tool and POInit builder. - _MSGINITLOCALE - - + + _MSGINITLOCALE + + Internal ``macro''. Computes locale (language) name based on target filename (default: '${TARGET.filebase}' ). - -See msginit tool and POInit builder. + +See msginit tool and POInit builder. - MSGMERGE - - + + MSGMERGE + + Absolute path to msgmerge(1) binary as found by Detect(). -See msgmerge tool and POUpdate builder. +See msgmerge tool and POUpdate builder. - MSGMERGECOM - - + + MSGMERGECOM + + Complete command line to run msgmerge(1) command. -See msgmerge tool and POUpdate builder. +See msgmerge tool and POUpdate builder. - MSGMERGECOMSTR - - + + MSGMERGECOMSTR + + String to be displayed when msgmerge(1) is invoked -(default: '', which means ``print $MSGMERGECOM''). -See msgmerge tool and POUpdate builder. +(default: '', which means ``print $MSGMERGECOM''). +See msgmerge tool and POUpdate builder. - MSGMERGEFLAGS - - + + MSGMERGEFLAGS + + Additional flags to msgmerge(1) command. -See msgmerge tool and POUpdate builder. +See msgmerge tool and POUpdate builder. - MSSDK_DIR - - + + MSSDK_DIR + + The directory containing the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. @@ -4176,9 +4521,10 @@ to be used for compilation. - MSSDK_VERSION - - + + MSSDK_VERSION + + The version string of the Microsoft SDK (either Platform SDK or Windows SDK) to be used for compilation. @@ -4193,9 +4539,10 @@ and - MSVC_BATCH - - + + MSVC_BATCH + + When set to any true value, specifies that SCons should batch compilation of object files @@ -4206,7 +4553,7 @@ and were configured in SCons using the same construction environment will be built in a single call to the compiler. Only source files that have changed since their object files were built will be passed to each compiler invocation -(via the $CHANGED_SOURCES construction variable). +(via the $CHANGED_SOURCES construction variable). Any compilations where the object (target) file base name (minus the .obj) does not match the source file base name @@ -4215,14 +4562,15 @@ will be compiled separately. - MSVC_USE_SCRIPT - - + + MSVC_USE_SCRIPT + + Use a batch script to set up Microsoft Visual Studio compiler - -$MSVC_USE_SCRIPT overrides $MSVC_VERSION and $TARGET_ARCH. + +$MSVC_USE_SCRIPT overrides $MSVC_VERSION and $TARGET_ARCH. If set to the name of a Visual Studio .bat file (e.g. vcvars.bat), SCons will run that bat file and extract the relevant variables from the result (typically %INCLUDE%, %LIB%, and %PATH%). Setting @@ -4233,14 +4581,15 @@ window and importing the shell's environment variables. - MSVC_UWP_APP - - + + MSVC_UWP_APP + + Build libraries for a Universal Windows Platform (UWP) Application. - -If $MSVC_UWP_APP is set, the Visual Studio environment will be set up to point + +If $MSVC_UWP_APP is set, the Visual Studio environment will be set up to point to the Windows Store compatible libraries and Visual Studio runtimes. In doing so, any libraries that are built will be able to be used in a UWP App and published to the Windows Store. @@ -4249,31 +4598,33 @@ This variable must be passed as an argument to the Environment() constructor; setting it later has no effect. - + Valid values are '1' or '0' - MSVC_VERSION - - + + MSVC_VERSION + + Sets the preferred version of Microsoft Visual C/C++ to use. - -If $MSVC_VERSION is not set, SCons will (by default) select the + +If $MSVC_VERSION is not set, SCons will (by default) select the latest version of Visual C/C++ installed on your system. If the specified version isn't installed, tool initialization will fail. This variable must be passed as an argument to the Environment() constructor; setting it later has no effect. - + Valid values for Windows are 14.2, 14.1, +14.1Exp, 14.0, 14.0Exp, 12.0, @@ -4296,17 +4647,18 @@ Versions ending in Exp refer to "Express" or - MSVS - - + + 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) + $MSVS_VERSION) VERSIONS @@ -4362,29 +4714,31 @@ Versions ending in Exp refer to "Express" or - If a value is not set, it was not available in the registry. + If a value is not set, it was not available in the registry. - MSVS_ARCH - - Sets the architecture for which the generated project(s) should build. - + + 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 + amd64 is also supported by SCons for most Visual Studio versions. Since Visual Studio 2015 arm is supported, and since Visual Studio 2017 arm64 is supported. - Trying to set $MSVS_ARCH + 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 - - + + 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 @@ -4395,9 +4749,10 @@ defined, a new GUID is generated. - MSVS_SCC_AUX_PATH - - + + 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 @@ -4409,9 +4764,10 @@ no default value. - MSVS_SCC_CONNECTION_ROOT - - + + 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 @@ -4434,9 +4790,10 @@ no default value. - MSVS_SCC_PROJECT_NAME - - + + 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 @@ -4450,9 +4807,10 @@ no default value. - MSVS_SCC_PROVIDER - - + + MSVS_SCC_PROVIDER + + The string placed in a generated Microsoft Visual Studio project file as the value of the SccProvider attribute. The string is @@ -4464,11 +4822,12 @@ 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) + + 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 @@ -4477,19 +4836,20 @@ no default value. 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, + + 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 - - + + 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. @@ -4497,9 +4857,10 @@ no default value. - MSVSCLEANCOM - - + + 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 @@ -4508,9 +4869,10 @@ no default value. - MSVSENCODING - - + + MSVSENCODING + + The encoding string placed in a generated Microsoft Visual Studio project file. The default is encoding Windows-1252. @@ -4518,15 +4880,17 @@ no default value. - MSVSPROJECTCOM - - The action used to generate Microsoft Visual Studio project files. + + MSVSPROJECTCOM + + The action used to generate Microsoft Visual Studio project files. - MSVSPROJECTSUFFIX - - + + 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, @@ -4536,9 +4900,10 @@ no default value. - MSVSREBUILDCOM - - + + 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. @@ -4547,9 +4912,10 @@ no default value. - MSVSSCONS - - + + 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. @@ -4557,44 +4923,49 @@ no default value. - MSVSSCONSCOM - - + + MSVSSCONSCOM + + The default SCons command used in generated Microsoft Visual Studio project files. - MSVSSCONSCRIPT - - - The sconscript file (that is, SConstruct or SConscript + + 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 + (through the $MSVSSCONSCOM variable). The default is the same sconscript file that contains the call to - MSVSProject to build the project file. + MSVSProject to build the project file. - MSVSSCONSFLAGS - - + + MSVSSCONSFLAGS + + The SCons flags used in generated Microsoft Visual Studio project files. - MSVSSOLUTIONCOM - - The action used to generate Microsoft Visual Studio solution files. + + MSVSSOLUTIONCOM + + The action used to generate Microsoft Visual Studio solution files. - MSVSSOLUTIONSUFFIX - - + + 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 @@ -4604,70 +4975,78 @@ no default value. - MT - - + + MT + + The program used on Windows systems to embed manifests into DLLs and EXEs. -See also $WINDOWS_EMBED_MANIFEST. +See also $WINDOWS_EMBED_MANIFEST. - MTEXECOM - - + + MTEXECOM + + The Windows command line used to embed manifests into executables. -See also $MTSHLIBCOM. +See also $MTSHLIBCOM. - MTFLAGS - - -Flags passed to the $MT manifest embedding program (Windows only). + + MTFLAGS + + +Flags passed to the $MT manifest embedding program (Windows only). - MTSHLIBCOM - - + + MTSHLIBCOM + + The Windows command line used to embed manifests into shared libraries (DLLs). -See also $MTEXECOM. +See also $MTEXECOM. - MWCW_VERSION - - + + MWCW_VERSION + + The version number of the MetroWerks CodeWarrior C compiler to be used. - MWCW_VERSIONS - - + + MWCW_VERSIONS + + A list of installed versions of the MetroWerks CodeWarrior C compiler on this system. - NAME - - + + NAME + + Specfies the name of the project to package. - no_import_lib - - + + no_import_lib + + When set to non-zero, suppresses creation of a corresponding Windows static import lib by the SharedLibrary @@ -4680,58 +5059,68 @@ when using Microsoft Visual Studio. - OBJPREFIX - - + + OBJPREFIX + + The prefix used for (static) object file names. - OBJSUFFIX - - + + OBJSUFFIX + + The suffix used for (static) object file names. - PACKAGEROOT - - + + PACKAGEROOT + + Specifies the directory where all files in resulting archive will be placed if applicable. The default value is "$NAME-$VERSION". - PACKAGETYPE - - + + PACKAGETYPE + + Selects the package type to build. Currently these are available: - - * msi - Microsoft Installer - * rpm - Redhat Package Manger - * ipkg - Itsy Package Management System - * tarbz2 - compressed tar - * targz - compressed tar - * zip - zip file - * src_tarbz2 - compressed tar source - * src_targz - compressed tar source - * src_zip - zip file source - +
+ +msi - Microsoft Installer +rpm - RPM Package Manger +ipkg - Itsy Package Management System +tarbz2 - bzip2 compressed tar +targz - gzip compressed tar +tarxz - xz compressed tar +zip - zip file +src_tarbz2 - bzip2 compressed tar source +src_targz - gzip compressed tar source +src_tarxz - xz compressed tar source +src_zip - zip file source + +
- -This may be overridden with the "package_type" command line option. + +This may be overridden with the +command line option. - PACKAGEVERSION - - + + PACKAGEVERSION + + The version of the package (not the underlying project). This is currently only used by the rpm packager and should reflect changes in the packaging, @@ -4740,9 +5129,10 @@ not the underlying project code itself. - PCH - - + + PCH + + The Microsoft Visual C++ precompiled header that will be used when compiling object files. This variable is ignored by tools other than Microsoft Visual C++. When this variable is @@ -4752,44 +5142,48 @@ dependencies for the PCH file. Example: - + env['PCH'] = 'StdAfx.pch' - PCHCOM - - + + PCHCOM + + The command line used by the -PCH +PCH builder to generated a precompiled header. - PCHCOMSTR - - + + PCHCOMSTR + + The string displayed when generating a precompiled header. -If this is not set, then $PCHCOM (the command line) is displayed. +If this is not set, then $PCHCOM (the command line) is displayed. - PCHPDBFLAGS - - + + PCHPDBFLAGS + + A construction variable that, when expanded, adds the /yD flag to the command line -only if the $PDB construction variable is set. +only if the $PDB construction variable is set. - PCHSTOP - - + + PCHSTOP + + This variable specifies how much of a source file is precompiled. This variable is ignored by tools other than Microsoft Visual C++, or when the PCH variable is not being used. When this variable is define it @@ -4798,15 +5192,16 @@ is included at the end of the precompiled portion of the source files, or the empty string if the "#pragma hrdstop" construct is being used: - + env['PCHSTOP'] = 'StdAfx.h' - PDB - - + + PDB + + The Microsoft Visual C++ PDB file that will store debugging information for object files, shared libraries, and programs. This variable is ignored by tools other than Microsoft Visual C++. @@ -4817,11 +5212,11 @@ dependencies for the PDB file. Example: - + env['PDB'] = 'hello.pdb' - + The Visual C++ compiler switch that SCons uses by default to generate PDB information is . This works correctly with parallel () builds @@ -4833,116 +5228,128 @@ Using the instead may yield improved link-time performance, although parallel builds will no longer work. You can generate PDB files with the -switch by overriding the default $CCPDBFLAGS variable; +switch by overriding the default $CCPDBFLAGS variable; see the entry for that variable for specific examples. - PDFCOM - - -A deprecated synonym for $DVIPDFCOM. + + PDFCOM + + +A deprecated synonym for $DVIPDFCOM. - PDFLATEX - - -The pdflatex utility. + + PDFLATEX + + +The pdflatex utility. - PDFLATEXCOM - - -The command line used to call the pdflatex utility. + + PDFLATEXCOM + + +The command line used to call the pdflatex utility. - PDFLATEXCOMSTR - - -The string displayed when calling the pdflatex utility. -If this is not set, then $PDFLATEXCOM (the command line) is displayed. + + PDFLATEXCOMSTR + + +The string displayed when calling the pdflatex utility. +If this is not set, then $PDFLATEXCOM (the command line) is displayed. - + env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES") - PDFLATEXFLAGS - - -General options passed to the pdflatex utility. + + PDFLATEXFLAGS + + +General options passed to the pdflatex utility. - PDFPREFIX - - + + PDFPREFIX + + The prefix used for PDF file names. - PDFSUFFIX - - + + PDFSUFFIX + + The suffix used for PDF file names. - PDFTEX - - -The pdftex utility. + + PDFTEX + + +The pdftex utility. - PDFTEXCOM - - -The command line used to call the pdftex utility. + + PDFTEXCOM + + +The command line used to call the pdftex utility. - PDFTEXCOMSTR - - -The string displayed when calling the pdftex utility. -If this is not set, then $PDFTEXCOM (the command line) is displayed. + + PDFTEXCOMSTR + + +The string displayed when calling the pdftex utility. +If this is not set, then $PDFTEXCOM (the command line) is displayed. - + env = Environment(PDFTEXCOMSTR = "Building $TARGET from TeX input $SOURCES") - PDFTEXFLAGS - - -General options passed to the pdftex utility. + + PDFTEXFLAGS + + +General options passed to the pdftex utility. - PKGCHK - - + + PKGCHK + + On Solaris systems, the package-checking program that will -be used (along with $PKGINFO) +be used (along with $PKGINFO) to look for installed versions of the Sun PRO C++ compiler. The default is @@ -4951,12 +5358,13 @@ The default is - PKGINFO - - + + PKGINFO + + On Solaris systems, the package information program that will -be used (along with $PKGCHK) +be used (along with $PKGCHK) to look for installed versions of the Sun PRO C++ compiler. The default is @@ -4965,16 +5373,17 @@ The default is - PLATFORM - - + + PLATFORM + + The name of the platform used to create the Environment. If no platform is specified when the Environment is created, -scons +scons autodetects the platform. - + env = Environment(tools = []) if env['PLATFORM'] == 'cygwin': Tool('mingw')(env) @@ -4984,84 +5393,92 @@ else: - POAUTOINIT - - -The $POAUTOINIT variable, if set to True (on non-zero -numeric value), let the msginit tool to automatically initialize + + POAUTOINIT + + +The $POAUTOINIT variable, if set to True (on non-zero +numeric value), let the msginit tool to automatically initialize missing PO files with msginit(1). This applies to both, -POInit and POUpdate builders (and others that use any of +POInit and POUpdate builders (and others that use any of them). - POCREATE_ALIAS - - -Common alias for all PO files created with POInit + + POCREATE_ALIAS + + +Common alias for all PO files created with POInit builder (default: 'po-create'). -See msginit tool and POInit builder. +See msginit tool and POInit builder. - POSUFFIX - - + + POSUFFIX + + Suffix used for PO files (default: '.po') -See msginit tool and POInit builder. +See msginit tool and POInit builder. - POTDOMAIN - - -The $POTDOMAIN defines default domain, used to generate -POT filename as $POTDOMAIN.pot when + + POTDOMAIN + + +The $POTDOMAIN defines default domain, used to generate +POT filename as $POTDOMAIN.pot when no POT file name is provided by the user. This applies to -POTUpdate, POInit and POUpdate builders (and -builders, that use them, e.g. Translate). Normally (if $POTDOMAIN is +POTUpdate, POInit and POUpdate builders (and +builders, that use them, e.g. Translate). Normally (if $POTDOMAIN is not defined), the builders use messages.pot as default POT file name. - POTSUFFIX - - + + POTSUFFIX + + Suffix used for PO Template files (default: '.pot'). -See xgettext tool and POTUpdate builder. +See xgettext tool and POTUpdate builder. - POTUPDATE_ALIAS - - + + POTUPDATE_ALIAS + + Name of the common phony target for all PO Templates created with -POUpdate (default: 'pot-update'). -See xgettext tool and POTUpdate builder. +POUpdate (default: 'pot-update'). +See xgettext tool and POTUpdate builder. - POUPDATE_ALIAS - - + + POUPDATE_ALIAS + + Common alias for all PO files being defined with -POUpdate builder (default: 'po-update'). -See msgmerge tool and POUpdate builder. +POUpdate builder (default: 'po-update'). +See msgmerge tool and POUpdate builder. - PRINT_CMD_LINE_FUNC - - + + PRINT_CMD_LINE_FUNC + + A Python function used to print the command lines as they are executed (assuming command printing is not disabled by the @@ -5079,20 +5496,20 @@ the source(s) used (file node, list, or string name(s)), and the environment being used. - + The function must do the printing itself. The default implementation, used if this variable is not set or is None, is: - + def print_cmd_line(s, target, source, env): sys.stdout.write(s + "\n") - + Here's an example of a more interesting function: - + def print_cmd_line(s, target, source, env): sys.stdout.write("Building %s -> %s...\n" % (' and '.join([str(x) for x in source]), @@ -5101,7 +5518,7 @@ env=Environment(PRINT_CMD_LINE_FUNC=print_cmd_line) env.Program('foo', 'foo.c') - + This just prints "Building targetname from sourcename..." instead of the actual commands. Such a function could also log the actual commands to a log file, @@ -5110,307 +5527,342 @@ for example. - PROGEMITTER - - + + PROGEMITTER + + Contains the emitter specification for the -Program builder. +Program builder. The manpage section "Builder Objects" contains general information on specifying emitters. - PROGPREFIX - - + + PROGPREFIX + + The prefix used for executable file names. - PROGSUFFIX - - + + PROGSUFFIX + + The suffix used for executable file names. - PSCOM - - + + PSCOM + + The command line used to convert TeX DVI files into a PostScript file. - PSCOMSTR - - + + PSCOMSTR + + The string displayed when a TeX DVI file is converted into a PostScript file. -If this is not set, then $PSCOM (the command line) is displayed. +If this is not set, then $PSCOM (the command line) is displayed. - PSPREFIX - - + + PSPREFIX + + The prefix used for PostScript file names. - PSSUFFIX - - + + PSSUFFIX + + The prefix used for PostScript file names. - QT_AUTOSCAN - - + + QT_AUTOSCAN + + Turn off scanning for mocable files. Use the Moc Builder to explicitly specify files to run moc on. - QT_BINPATH - - + + QT_BINPATH + + The path where the qt binaries are installed. -The default value is '$QTDIR/bin'. +The default value is '$QTDIR/bin'. - QT_CPPPATH - - + + QT_CPPPATH + + The path where the qt header files are installed. -The default value is '$QTDIR/include'. +The default value is '$QTDIR/include'. Note: If you set this variable to None, -the tool won't change the $CPPPATH +the tool won't change the $CPPPATH construction variable. - QT_DEBUG - - + + QT_DEBUG + + Prints lots of debugging information while scanning for moc files. - QT_LIB - - + + QT_LIB + + Default value is 'qt'. You may want to set this to 'qt-mt'. Note: If you set -this variable to None, the tool won't change the $LIBS variable. +this variable to None, the tool won't change the $LIBS variable. - QT_LIBPATH - - + + QT_LIBPATH + + The path where the qt libraries are installed. -The default value is '$QTDIR/lib'. +The default value is '$QTDIR/lib'. Note: If you set this variable to None, -the tool won't change the $LIBPATH +the tool won't change the $LIBPATH construction variable. - QT_MOC - - -Default value is '$QT_BINPATH/moc'. + + QT_MOC + + +Default value is '$QT_BINPATH/moc'. - QT_MOCCXXPREFIX - - + + QT_MOCCXXPREFIX + + Default value is ''. Prefix for moc output files, when source is a cxx file. - QT_MOCCXXSUFFIX - - + + QT_MOCCXXSUFFIX + + Default value is '.moc'. Suffix for moc output files, when source is a cxx file. - QT_MOCFROMCXXCOM - - + + QT_MOCFROMCXXCOM + + Command to generate a moc file from a cpp file. - QT_MOCFROMCXXCOMSTR - - + + QT_MOCFROMCXXCOMSTR + + The string displayed when generating a moc file from a cpp file. -If this is not set, then $QT_MOCFROMCXXCOM (the command line) is displayed. +If this is not set, then $QT_MOCFROMCXXCOM (the command line) is displayed. - QT_MOCFROMCXXFLAGS - - + + QT_MOCFROMCXXFLAGS + + Default value is '-i'. These flags are passed to moc, when moccing a C++ file. - QT_MOCFROMHCOM - - + + QT_MOCFROMHCOM + + Command to generate a moc file from a header. - QT_MOCFROMHCOMSTR - - + + QT_MOCFROMHCOMSTR + + The string displayed when generating a moc file from a cpp file. -If this is not set, then $QT_MOCFROMHCOM (the command line) is displayed. +If this is not set, then $QT_MOCFROMHCOM (the command line) is displayed. - QT_MOCFROMHFLAGS - - + + QT_MOCFROMHFLAGS + + Default value is ''. These flags are passed to moc, when moccing a header file. - QT_MOCHPREFIX - - + + QT_MOCHPREFIX + + Default value is 'moc_'. Prefix for moc output files, when source is a header. - QT_MOCHSUFFIX - - -Default value is '$CXXFILESUFFIX'. Suffix for moc output files, when source is + + QT_MOCHSUFFIX + + +Default value is '$CXXFILESUFFIX'. Suffix for moc output files, when source is a header. - QT_UIC - - -Default value is '$QT_BINPATH/uic'. + + QT_UIC + + +Default value is '$QT_BINPATH/uic'. - QT_UICCOM - - + + QT_UICCOM + + Command to generate header files from .ui files. - QT_UICCOMSTR - - + + QT_UICCOMSTR + + The string displayed when generating header files from .ui files. -If this is not set, then $QT_UICCOM (the command line) is displayed. +If this is not set, then $QT_UICCOM (the command line) is displayed. - QT_UICDECLFLAGS - - + + QT_UICDECLFLAGS + + Default value is ''. These flags are passed to uic, when creating a a h file from a .ui file. - QT_UICDECLPREFIX - - + + QT_UICDECLPREFIX + + Default value is ''. Prefix for uic generated header files. - QT_UICDECLSUFFIX - - + + QT_UICDECLSUFFIX + + Default value is '.h'. Suffix for uic generated header files. - QT_UICIMPLFLAGS - - + + QT_UICIMPLFLAGS + + Default value is ''. These flags are passed to uic, when creating a cxx file from a .ui file. - QT_UICIMPLPREFIX - - + + QT_UICIMPLPREFIX + + Default value is 'uic_'. Prefix for uic generated implementation files. - QT_UICIMPLSUFFIX - - -Default value is '$CXXFILESUFFIX'. Suffix for uic generated implementation + + QT_UICIMPLSUFFIX + + +Default value is '$CXXFILESUFFIX'. Suffix for uic generated implementation files. - QT_UISUFFIX - - + + QT_UISUFFIX + + Default value is '.ui'. Suffix of designer input files. - QTDIR - - + + QTDIR + + The qt tool tries to take this from os.environ. It also initializes all QT_* construction variables listed below. @@ -5419,24 +5871,24 @@ with python's os.path.join() method, but are listed here with the '/' separator for easier reading.) In addition, the construction environment -variables $CPPPATH, -$LIBPATH and -$LIBS may be modified +variables $CPPPATH, +$LIBPATH and +$LIBS may be modified and the variables -$PROGEMITTER, $SHLIBEMITTER and $LIBEMITTER +$PROGEMITTER, $SHLIBEMITTER and $LIBEMITTER are modified. Because the build-performance is affected when using this tool, you have to explicitly specify it at Environment creation: - + Environment(tools=['default','qt']) - + The qt tool supports the following operations: - + Automatic moc file generation from header files. You do not have to specify moc files explicitly, the tool does it for you. However, there are a few preconditions to do so: Your header file must have @@ -5444,11 +5896,11 @@ the same filebase as your implementation file and must stay in the same directory. It must have one of the suffixes .h, .hpp, .H, .hxx, .hh. You can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. See also the corresponding -Moc() +Moc() builder method. - + Automatic moc file generation from cxx files. As stated in the qt documentation, include the moc file at the end of the cxx file. Note that you have to include the file, which is generated @@ -5457,11 +5909,11 @@ by the transformation ${QT_MOCCXXPREFIX}<basename>${QT_MOCCXXSUFFIX}, by d do not include the correct file. If you are using VariantDir, you may need to specify duplicate=1. You can turn off automatic moc file generation by setting QT_AUTOSCAN to 0. See also the corresponding -Moc +Moc builder method. - + Automatic handling of .ui files. The implementation files generated from .ui files are handled much the same as yacc or lex files. Each .ui file given as a source of Program, Library or @@ -5469,168 +5921,184 @@ SharedLibrary will generate three files, the declaration file, the implementation file and a moc file. Because there are also generated headers, you may need to specify duplicate=1 in calls to VariantDir. See also the corresponding -Uic +Uic builder method. - RANLIB - - + + RANLIB + + The archive indexer. - RANLIBCOM - - + + RANLIBCOM + + The command line used to index a static library archive. - RANLIBCOMSTR - - + + RANLIBCOMSTR + + The string displayed when a static library archive is indexed. -If this is not set, then $RANLIBCOM (the command line) is displayed. +If this is not set, then $RANLIBCOM (the command line) is displayed. - + env = Environment(RANLIBCOMSTR = "Indexing $TARGET") - RANLIBFLAGS - - + + RANLIBFLAGS + + General options passed to the archive indexer. - RC - - + + RC + + The resource compiler used to build a Microsoft Visual C++ resource file. - RCCOM - - + + RCCOM + + The command line used to build a Microsoft Visual C++ resource file. - RCCOMSTR - - + + RCCOMSTR + + The string displayed when invoking the resource compiler to build a Microsoft Visual C++ resource file. -If this is not set, then $RCCOM (the command line) is displayed. +If this is not set, then $RCCOM (the command line) is displayed. - RCFLAGS - - + + RCFLAGS + + The flags passed to the resource compiler by the RES builder. - RCINCFLAGS - - + + RCINCFLAGS + + An automatically-generated construction variable containing the command-line options for specifying directories to be searched by the resource compiler. -The value of $RCINCFLAGS is created +The value of $RCINCFLAGS is created by respectively prepending and appending -$RCINCPREFIX and $RCINCSUFFIX +$RCINCPREFIX and $RCINCSUFFIX to the beginning and end -of each directory in $CPPPATH. +of each directory in $CPPPATH. - RCINCPREFIX - - + + RCINCPREFIX + + The prefix (flag) used to specify an include directory on the resource compiler command line. This will be prepended to the beginning of each directory -in the $CPPPATH construction variable -when the $RCINCFLAGS variable is expanded. +in the $CPPPATH construction variable +when the $RCINCFLAGS variable is expanded. - RCINCSUFFIX - - + + RCINCSUFFIX + + The suffix used to specify an include directory on the resource compiler command line. This will be appended to the end of each directory -in the $CPPPATH construction variable -when the $RCINCFLAGS variable is expanded. +in the $CPPPATH construction variable +when the $RCINCFLAGS variable is expanded. - RDirs - - + + RDirs + + A function that converts a string into a list of Dir instances by searching the repositories. - REGSVR - - + + REGSVR + + The program used on Windows systems to register a newly-built DLL library -whenever the SharedLibrary builder +whenever the SharedLibrary builder is passed a keyword argument of register=1. - REGSVRCOM - - + + REGSVRCOM + + The command line used on Windows systems to register a newly-built DLL library -whenever the SharedLibrary builder +whenever the SharedLibrary builder is passed a keyword argument of register=1. - REGSVRCOMSTR - - + + REGSVRCOMSTR + + The string displayed when registering a newly-built DLL file. -If this is not set, then $REGSVRCOM (the command line) is displayed. +If this is not set, then $REGSVRCOM (the command line) is displayed. - REGSVRFLAGS - - + + REGSVRFLAGS + + Flags passed to the DLL registration program on Windows systems when a newly-built DLL library is registered. By default, @@ -5641,170 +6109,185 @@ and requiring user attention. - RMIC - - + + RMIC + + The Java RMI stub compiler. - RMICCOM - - + + RMICCOM + + The command line used to compile stub and skeleton class files from Java classes that contain RMI implementations. -Any options specified in the $RMICFLAGS construction variable +Any options specified in the $RMICFLAGS construction variable are included on this command line. - RMICCOMSTR - - + + RMICCOMSTR + + The string displayed when compiling stub and skeleton class files from Java classes that contain RMI implementations. -If this is not set, then $RMICCOM (the command line) is displayed. +If this is not set, then $RMICCOM (the command line) is displayed. - + env = Environment(RMICCOMSTR = "Generating stub/skeleton class files $TARGETS from $SOURCES") - RMICFLAGS - - + + RMICFLAGS + + General options passed to the Java RMI stub compiler. - - _RPATH - - -An automatically-generated construction variable -containing the rpath flags to be used when linking -a program with shared libraries. -The value of $_RPATH is created -by respectively prepending $RPATHPREFIX and appending $RPATHSUFFIX -to the beginning and end -of each directory in $RPATH. - - - - RPATH - - + + RPATH + + A list of paths to search for shared libraries when running programs. Currently only used in the GNU (gnulink), IRIX (sgilink) and Sun (sunlink) linkers. Ignored on platforms and toolchains that don't support it. Note that the paths added to RPATH are not transformed by -scons +scons in any way: if you want an absolute path, you must make it absolute yourself. + + + _RPATH + + +An automatically-generated construction variable +containing the rpath flags to be used when linking +a program with shared libraries. +The value of $_RPATH is created +by respectively prepending $RPATHPREFIX and appending $RPATHSUFFIX +to the beginning and end +of each directory in $RPATH. + + + - RPATHPREFIX - - + + RPATHPREFIX + + The prefix used to specify a directory to be searched for shared libraries when running programs. This will be prepended to the beginning of each directory -in the $RPATH construction variable -when the $_RPATH variable is automatically generated. +in the $RPATH construction variable +when the $_RPATH variable is automatically generated. - RPATHSUFFIX - - + + RPATHSUFFIX + + The suffix used to specify a directory to be searched for shared libraries when running programs. This will be appended to the end of each directory -in the $RPATH construction variable -when the $_RPATH variable is automatically generated. +in the $RPATH construction variable +when the $_RPATH variable is automatically generated. - RPCGEN - - + + RPCGEN + + The RPC protocol compiler. - RPCGENCLIENTFLAGS - - + + RPCGENCLIENTFLAGS + + Options passed to the RPC protocol compiler when generating client side stubs. These are in addition to any flags specified in the -$RPCGENFLAGS +$RPCGENFLAGS construction variable. - RPCGENFLAGS - - + + RPCGENFLAGS + + General options passed to the RPC protocol compiler. - RPCGENHEADERFLAGS - - + + RPCGENHEADERFLAGS + + Options passed to the RPC protocol compiler when generating a header file. These are in addition to any flags specified in the -$RPCGENFLAGS +$RPCGENFLAGS construction variable. - RPCGENSERVICEFLAGS - - + + RPCGENSERVICEFLAGS + + Options passed to the RPC protocol compiler when generating server side stubs. These are in addition to any flags specified in the -$RPCGENFLAGS +$RPCGENFLAGS construction variable. - RPCGENXDRFLAGS - - + + RPCGENXDRFLAGS + + Options passed to the RPC protocol compiler when generating XDR routines. These are in addition to any flags specified in the -$RPCGENFLAGS +$RPCGENFLAGS construction variable. - SCANNERS - - + + SCANNERS + + A list of the available implicit dependency scanners. New file scanners may be added by appending to this list, @@ -5818,231 +6301,279 @@ for more information. - SCONS_HOME - - + + 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 + the $MSVSSCONS command line executed from Microsoft Visual Studio project files. - SHCC - - + + SHCC + + The C compiler used for generating shared-library objects. +See also $CC for compiling to static objects. - SHCCCOM - - + + SHCCCOM + + The command line used to compile a C source file to a shared-library object file. -Any options specified in the $SHCFLAGS, -$SHCCFLAGS and -$CPPFLAGS construction variables +Any options specified in the $SHCFLAGS, +$SHCCFLAGS and +$CPPFLAGS construction variables are included on this command line. +See also $CCCOM for compiling to static objects. - SHCCCOMSTR - - -The string displayed when a C source file + + SHCCCOMSTR + + +If set, the string displayed when a C source file is compiled to a shared object file. -If this is not set, then $SHCCCOM (the command line) is displayed. +If not set, then $SHCCCOM (the command line) is displayed. +See also $CCCOMSTR for compiling to static objects. - + env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET") - SHCCFLAGS - - + + SHCCFLAGS + + Options that are passed to the C and C++ compilers to generate shared-library objects. +See also $CCFLAGS for compiling to static objects. - SHCFLAGS - - + + SHCFLAGS + + Options that are passed to the C compiler (only; not C++) to generate shared-library objects. +See also $CFLAGS for compiling to static objects. - SHCXX - - + + SHCXX + + The C++ compiler used for generating shared-library objects. +See also $CXX for compiling to static objects. - SHCXXCOM - - + + SHCXXCOM + + The command line used to compile a C++ source file to a shared-library object file. -Any options specified in the $SHCXXFLAGS and -$CPPFLAGS construction variables +Any options specified in the $SHCXXFLAGS and +$CPPFLAGS construction variables are included on this command line. +See also $CXXCOM for compiling to static objects. - SHCXXCOMSTR - - -The string displayed when a C++ source file + + SHCXXCOMSTR + + +If set, the string displayed when a C++ source file is compiled to a shared object file. -If this is not set, then $SHCXXCOM (the command line) is displayed. +If not set, then $SHCXXCOM (the command line) is displayed. +See also $CXXCOMSTR for compiling to static objects. - + env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET") - SHCXXFLAGS - - + + SHCXXFLAGS + + Options that are passed to the C++ compiler to generate shared-library objects. +See also $CXXFLAGS for compiling to static objects. - SHDC - - + + SHDC + + The name of the compiler to use when compiling D source destined to be in a shared objects. +See also $DC for compiling to static objects. - SHDCOM - - + + SHDCOM + + The command line to use when compiling code to be part of shared objects. +See also $DCOM for compiling to static objects. + + + + + + SHDCOMSTR + + +If set, the string displayed when a D source file +is compiled to a (shared) object file. +If not set, then $SHDCOM (the command line) is displayed. +See also $DCOMSTR for compiling to static objects. - SHDLIBVERSION - - + + SHDLIBVERSION + + SHDLIBVERSION. - SHDLIBVERSIONFLAGS - - + + SHDLIBVERSIONFLAGS + + SHDLIBVERSIONFLAGS. - SHDLINK - - + + SHDLINK + + The linker to use when creating shared objects for code bases include D sources. +See also $DLINK for linking static objects. - SHDLINKCOM - - + + SHDLINKCOM + + The command line to use when generating shared objects. +See also $DLINKCOM for linking static objects. - SHDLINKFLAGS - - + + SHDLINKFLAGS + + The list of flags to use when generating a shared object. +See also $DLINKFLAGS for linking static objects. - SHELL - - + + SHELL + + A string naming the shell program that will be passed to the -$SPAWN +$SPAWN function. See the -$SPAWN +$SPAWN construction variable for more information. - SHF03 - - + + SHF03 + + The Fortran 03 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $SHF03 if you need to use a specific compiler +You only need to set $SHF03 if you need to use a specific compiler or compiler version for Fortran 03 files. - SHF03COM - - + + SHF03COM + + The command line used to compile a Fortran 03 source file to a shared-library object file. -You only need to set $SHF03COM if you need to use a specific +You only need to set $SHF03COM if you need to use a specific command line for Fortran 03 files. -You should normally set the $SHFORTRANCOM variable, +You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions. - SHF03COMSTR - - -The string displayed when a Fortran 03 source file + + SHF03COMSTR + + +If set, the string displayed when a Fortran 03 source file is compiled to a shared-library object file. -If this is not set, then $SHF03COM or $SHFORTRANCOM +If not set, then $SHF03COM or $SHFORTRANCOM (the command line) is displayed. - SHF03FLAGS - - + + SHF03FLAGS + + Options that are passed to the Fortran 03 compiler to generated shared-library objects. -You only need to set $SHF03FLAGS if you need to define specific +You only need to set $SHF03FLAGS if you need to define specific user options for Fortran 03 files. -You should normally set the $SHFORTRANFLAGS variable, +You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6050,81 +6581,87 @@ for all Fortran versions. - SHF03PPCOM - - + + SHF03PPCOM + + The command line used to compile a Fortran 03 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the $SHF03FLAGS and $CPPFLAGS construction variables +Any options specified in the $SHF03FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $SHF03PPCOM if you need to use a specific +You only need to set $SHF03PPCOM if you need to use a specific C-preprocessor command line for Fortran 03 files. -You should normally set the $SHFORTRANPPCOM variable, +You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - SHF03PPCOMSTR - - -The string displayed when a Fortran 03 source file + + SHF03PPCOMSTR + + +If set, the string displayed when a Fortran 03 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 $SHF03PPCOM or $SHFORTRANPPCOM +If not set, then $SHF03PPCOM or $SHFORTRANPPCOM (the command line) is displayed. - SHF08 - - + + SHF08 + + The Fortran 08 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +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 +You only need to set $SHF08 if you need to use a specific compiler or compiler version for Fortran 08 files. - SHF08COM - - + + 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 +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, +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 + + SHF08COMSTR + + +If set, 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 +If not set, then $SHF08COM or $SHFORTRANCOM (the command line) is displayed. - SHF08FLAGS - - + + 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 +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, +You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6132,81 +6669,87 @@ for all Fortran versions. - SHF08PPCOM - - + + 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 +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 +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, +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 + + SHF08PPCOMSTR + + +If set, 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 +If not set, then $SHF08PPCOM or $SHFORTRANPPCOM (the command line) is displayed. - SHF77 - - + + SHF77 + + The Fortran 77 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $SHF77 if you need to use a specific compiler +You only need to set $SHF77 if you need to use a specific compiler or compiler version for Fortran 77 files. - SHF77COM - - + + SHF77COM + + The command line used to compile a Fortran 77 source file to a shared-library object file. -You only need to set $SHF77COM if you need to use a specific +You only need to set $SHF77COM if you need to use a specific command line for Fortran 77 files. -You should normally set the $SHFORTRANCOM variable, +You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions. - SHF77COMSTR - - -The string displayed when a Fortran 77 source file + + SHF77COMSTR + + +If set, the string displayed when a Fortran 77 source file is compiled to a shared-library object file. -If this is not set, then $SHF77COM or $SHFORTRANCOM +If not set, then $SHF77COM or $SHFORTRANCOM (the command line) is displayed. - SHF77FLAGS - - + + SHF77FLAGS + + Options that are passed to the Fortran 77 compiler to generated shared-library objects. -You only need to set $SHF77FLAGS if you need to define specific +You only need to set $SHF77FLAGS if you need to define specific user options for Fortran 77 files. -You should normally set the $SHFORTRANFLAGS variable, +You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6214,81 +6757,87 @@ for all Fortran versions. - SHF77PPCOM - - + + SHF77PPCOM + + The command line used to compile a Fortran 77 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the $SHF77FLAGS and $CPPFLAGS construction variables +Any options specified in the $SHF77FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $SHF77PPCOM if you need to use a specific +You only need to set $SHF77PPCOM if you need to use a specific C-preprocessor command line for Fortran 77 files. -You should normally set the $SHFORTRANPPCOM variable, +You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - SHF77PPCOMSTR - - -The string displayed when a Fortran 77 source file + + SHF77PPCOMSTR + + +If set, the string displayed when a Fortran 77 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 $SHF77PPCOM or $SHFORTRANPPCOM +If not set, then $SHF77PPCOM or $SHFORTRANPPCOM (the command line) is displayed. - SHF90 - - + + SHF90 + + The Fortran 90 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $SHF90 if you need to use a specific compiler +You only need to set $SHF90 if you need to use a specific compiler or compiler version for Fortran 90 files. - SHF90COM - - + + SHF90COM + + The command line used to compile a Fortran 90 source file to a shared-library object file. -You only need to set $SHF90COM if you need to use a specific +You only need to set $SHF90COM if you need to use a specific command line for Fortran 90 files. -You should normally set the $SHFORTRANCOM variable, +You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions. - SHF90COMSTR - - -The string displayed when a Fortran 90 source file + + SHF90COMSTR + + +If set, the string displayed when a Fortran 90 source file is compiled to a shared-library object file. -If this is not set, then $SHF90COM or $SHFORTRANCOM +If not set, then $SHF90COM or $SHFORTRANCOM (the command line) is displayed. - SHF90FLAGS - - + + SHF90FLAGS + + Options that are passed to the Fortran 90 compiler to generated shared-library objects. -You only need to set $SHF90FLAGS if you need to define specific +You only need to set $SHF90FLAGS if you need to define specific user options for Fortran 90 files. -You should normally set the $SHFORTRANFLAGS variable, +You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6296,81 +6845,87 @@ for all Fortran versions. - SHF90PPCOM - - + + SHF90PPCOM + + The command line used to compile a Fortran 90 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the $SHF90FLAGS and $CPPFLAGS construction variables +Any options specified in the $SHF90FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $SHF90PPCOM if you need to use a specific +You only need to set $SHF90PPCOM if you need to use a specific C-preprocessor command line for Fortran 90 files. -You should normally set the $SHFORTRANPPCOM variable, +You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - SHF90PPCOMSTR - - -The string displayed when a Fortran 90 source file + + SHF90PPCOMSTR + + +If set, the string displayed when a Fortran 90 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 $SHF90PPCOM or $SHFORTRANPPCOM +If not set, then $SHF90PPCOM or $SHFORTRANPPCOM (the command line) is displayed. - SHF95 - - + + SHF95 + + The Fortran 95 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the $SHFORTRAN variable, which specifies the default Fortran compiler for all Fortran versions. -You only need to set $SHF95 if you need to use a specific compiler +You only need to set $SHF95 if you need to use a specific compiler or compiler version for Fortran 95 files. - SHF95COM - - + + SHF95COM + + The command line used to compile a Fortran 95 source file to a shared-library object file. -You only need to set $SHF95COM if you need to use a specific +You only need to set $SHF95COM if you need to use a specific command line for Fortran 95 files. -You should normally set the $SHFORTRANCOM variable, +You should normally set the $SHFORTRANCOM variable, which specifies the default command line for all Fortran versions. - SHF95COMSTR - - -The string displayed when a Fortran 95 source file + + SHF95COMSTR + + +If set, the string displayed when a Fortran 95 source file is compiled to a shared-library object file. -If this is not set, then $SHF95COM or $SHFORTRANCOM +If not set, then $SHF95COM or $SHFORTRANCOM (the command line) is displayed. - SHF95FLAGS - - + + SHF95FLAGS + + Options that are passed to the Fortran 95 compiler to generated shared-library objects. -You only need to set $SHF95FLAGS if you need to define specific +You only need to set $SHF95FLAGS if you need to define specific user options for Fortran 95 files. -You should normally set the $SHFORTRANFLAGS variable, +You should normally set the $SHFORTRANFLAGS variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6378,164 +6933,179 @@ for all Fortran versions. - SHF95PPCOM - - + + SHF95PPCOM + + The command line used to compile a Fortran 95 source file to a shared-library object file after first running the file through the C preprocessor. -Any options specified in the $SHF95FLAGS and $CPPFLAGS construction variables +Any options specified in the $SHF95FLAGS and $CPPFLAGS construction variables are included on this command line. -You only need to set $SHF95PPCOM if you need to use a specific +You only need to set $SHF95PPCOM if you need to use a specific C-preprocessor command line for Fortran 95 files. -You should normally set the $SHFORTRANPPCOM variable, +You should normally set the $SHFORTRANPPCOM variable, which specifies the default C-preprocessor command line for all Fortran versions. - SHF95PPCOMSTR - - -The string displayed when a Fortran 95 source file + + SHF95PPCOMSTR + + +If set, the string displayed when a Fortran 95 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 $SHF95PPCOM or $SHFORTRANPPCOM +If not set, then $SHF95PPCOM or $SHFORTRANPPCOM (the command line) is displayed. - SHFORTRAN - - + + SHFORTRAN + + The default Fortran compiler used for generating shared-library objects. - SHFORTRANCOM - - + + SHFORTRANCOM + + The command line used to compile a Fortran source file to a shared-library object file. - SHFORTRANCOMSTR - - -The string displayed when a Fortran source file + + SHFORTRANCOMSTR + + +If set, the string displayed when a Fortran source file is compiled to a shared-library object file. -If this is not set, then $SHFORTRANCOM +If not set, then $SHFORTRANCOM (the command line) is displayed. - SHFORTRANFLAGS - - + + SHFORTRANFLAGS + + Options that are passed to the Fortran compiler to generate shared-library objects. - SHFORTRANPPCOM - - + + SHFORTRANPPCOM + + The command line used to compile a Fortran source file to a shared-library object file after first running the file through the C preprocessor. Any options specified -in the $SHFORTRANFLAGS and -$CPPFLAGS construction variables +in the $SHFORTRANFLAGS and +$CPPFLAGS construction variables are included on this command line. - SHFORTRANPPCOMSTR - - -The string displayed when a Fortran source file + + SHFORTRANPPCOMSTR + + +If set, the string displayed when a Fortran 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 $SHFORTRANPPCOM +If not set, then $SHFORTRANPPCOM (the command line) is displayed. - SHLIBEMITTER - - + + SHLIBEMITTER + + Contains the emitter specification for the -SharedLibrary builder. +SharedLibrary builder. The manpage section "Builder Objects" contains general information on specifying emitters. - SHLIBNOVERSIONSYMLINKS - - -Instructs the SharedLibrary builder to not create symlinks for versioned + + SHLIBNOVERSIONSYMLINKS + + +Instructs the SharedLibrary builder to not create symlinks for versioned shared libraries. - SHLIBPREFIX - - + + SHLIBPREFIX + + The prefix used for shared library file names. - _SHLIBSONAME - - + + _SHLIBSONAME + + A macro that automatically generates shared library's SONAME based on $TARGET, -$SHLIBVERSION and $SHLIBSUFFIX. Used by SharedLibrary builder when -the linker tool supports SONAME (e.g. gnulink). +$SHLIBVERSION and $SHLIBSUFFIX. Used by SharedLibrary builder when +the linker tool supports SONAME (e.g. gnulink). - SHLIBSUFFIX - - + + SHLIBSUFFIX + + The suffix used for shared library file names. - SHLIBVERSION - - + + SHLIBVERSION + + When this construction variable is defined, a versioned shared library -is created by the SharedLibrary builder. This activates the -$_SHLIBVERSIONFLAGS and thus modifies the $SHLINKCOM as +is created by the SharedLibrary builder. This activates the +$_SHLIBVERSIONFLAGS and thus modifies the $SHLINKCOM as required, adds the version number to the library name, and creates the symlinks -that are needed. $SHLIBVERSION versions should exist as alpha-numeric, +that are needed. $SHLIBVERSION versions should exist as alpha-numeric, decimal-delimited values as defined by the regular expression "\w+[\.\w+]*". -Example $SHLIBVERSION values include '1', '1.2.3', and '1.2.gitaa412c8b'. +Example $SHLIBVERSION values include '1', '1.2.3', and '1.2.gitaa412c8b'. - _SHLIBVERSIONFLAGS - - -This macro automatically introduces extra flags to $SHLINKCOM when -building versioned SharedLibrary (that is when $SHLIBVERSION -is set). _SHLIBVERSIONFLAGS usually adds $SHLIBVERSIONFLAGS + + _SHLIBVERSIONFLAGS + + +This macro automatically introduces extra flags to $SHLINKCOM when +building versioned SharedLibrary (that is when $SHLIBVERSION +is set). _SHLIBVERSIONFLAGS usually adds $SHLIBVERSIONFLAGS and some extra dynamically generated options (such as -Wl,-soname=$_SHLIBSONAME. It is unused by "plain" (unversioned) shared libraries. @@ -6543,101 +7113,114 @@ and some extra dynamically generated options (such as - SHLIBVERSIONFLAGS - - -Extra flags added to $SHLINKCOM when building versioned -SharedLibrary. These flags are only used when $SHLIBVERSION is + + SHLIBVERSIONFLAGS + + +Extra flags added to $SHLINKCOM when building versioned +SharedLibrary. These flags are only used when $SHLIBVERSION is set. - SHLINK - - + + SHLINK + + The linker for programs that use shared libraries. +See also $LINK for linking static objects. - SHLINKCOM - - + + SHLINKCOM + + The command line used to link programs using shared libraries. +See also $LINKCOM for linking static objects. - SHLINKCOMSTR - - + + SHLINKCOMSTR + + The string displayed when programs using shared libraries are linked. -If this is not set, then $SHLINKCOM (the command line) is displayed. +If this is not set, then $SHLINKCOM (the command line) is displayed. +See also $LINKCOMSTR for linking static objects. - + env = Environment(SHLINKCOMSTR = "Linking shared $TARGET") - SHLINKFLAGS - - + + SHLINKFLAGS + + General user options passed to the linker for programs using shared libraries. Note that this variable should not contain -(or similar) options for linking with the libraries listed in $LIBS, +(or similar) options for linking with the libraries listed in $LIBS, nor (or similar) include search path options -that scons generates automatically from $LIBPATH. +that scons generates automatically from $LIBPATH. See -$_LIBFLAGS +$_LIBFLAGS above, for the variable that expands to library-link options, and -$_LIBDIRFLAGS +$_LIBDIRFLAGS above, for the variable that expands to library search path options. +See also $LINKFLAGS for linking static objects. - SHOBJPREFIX - - + + SHOBJPREFIX + + The prefix used for shared object file names. - SHOBJSUFFIX - - + + SHOBJSUFFIX + + The suffix used for shared object file names. - SONAME - - + + SONAME + + Variable used to hard-code SONAME for versioned shared library/loadable module. env.SharedLibrary('test', 'test.c', SHLIBVERSION='0.1.2', SONAME='libtest.so.2') -The variable is used, for example, by gnulink linker tool. +The variable is used, for example, by gnulink linker tool. - SOURCE - - + + SOURCE + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -6646,9 +7229,10 @@ for more information). - SOURCE_URL - - + + SOURCE_URL + + The URL (web address) of the location from which the project was retrieved. @@ -6659,9 +7243,10 @@ field in the controlling information for Ipkg and RPM packages. - SOURCES - - + + SOURCES + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -6670,18 +7255,19 @@ for more information). - SPAWN - - + + SPAWN + + A command interpreter function that will be called to execute command line strings. The function must expect the following arguments: - + def spawn(shell, escape, cmd, args, env): - + sh is a string naming the shell program to use. escape @@ -6698,18 +7284,20 @@ in which the command should be executed. - STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME - - + + STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME + + When this variable is true, static objects and shared objects are assumed to be the same; that is, SCons does not check for linking static objects into a shared library. - SUBST_DICT - - -The dictionary used by the Substfile or Textfile builders + + SUBST_DICT + + +The dictionary used by the Substfile or Textfile builders for substitution values. It can be anything acceptable to the dict() constructor, so in addition to a dictionary, @@ -6718,27 +7306,30 @@ lists of tuples are also acceptable. - SUBSTFILEPREFIX - - -The prefix used for Substfile file names, -the null string by default. + + SUBSTFILEPREFIX + + +The prefix used for Substfile file names, +an empty string by default. - SUBSTFILESUFFIX - - -The suffix used for Substfile file names, -the null string by default. + + SUBSTFILESUFFIX + + +The suffix used for Substfile file names, +an empty string by default. - SUMMARY - - + + SUMMARY + + A short summary of what the project is about. This is used to fill in the Summary: @@ -6750,72 +7341,78 @@ field in MSI packages. - SWIG - - + + SWIG + + The scripting language wrapper and interface generator. - SWIGCFILESUFFIX - - + + SWIGCFILESUFFIX + + The suffix that will be used for intermediate C source files generated by the scripting language wrapper and interface generator. The default value is -_wrap$CFILESUFFIX. +_wrap$CFILESUFFIX. By default, this value is used whenever the option is not specified as part of the -$SWIGFLAGS +$SWIGFLAGS construction variable. - SWIGCOM - - + + SWIGCOM + + The command line used to call the scripting language wrapper and interface generator. - SWIGCOMSTR - - + + SWIGCOMSTR + + The string displayed when calling the scripting language wrapper and interface generator. -If this is not set, then $SWIGCOM (the command line) is displayed. +If this is not set, then $SWIGCOM (the command line) is displayed. - SWIGCXXFILESUFFIX - - + + SWIGCXXFILESUFFIX + + The suffix that will be used for intermediate C++ source files generated by the scripting language wrapper and interface generator. The default value is -_wrap$CFILESUFFIX. +_wrap$CFILESUFFIX. By default, this value is used whenever the -c++ option is specified as part of the -$SWIGFLAGS +$SWIGFLAGS construction variable. - SWIGDIRECTORSUFFIX - - + + SWIGDIRECTORSUFFIX + + The suffix that will be used for intermediate C++ header files generated by the scripting language wrapper and interface generator. These are only generated for C++ code when the SWIG 'directors' feature is @@ -6826,9 +7423,10 @@ The default value is - SWIGFLAGS - - + + SWIGFLAGS + + General options passed to the scripting language wrapper and interface generator. This is where you should set @@ -6839,77 +7437,82 @@ or whatever other options you want to specify to SWIG. If you set the option in this variable, -scons +scons will, by default, generate a C++ intermediate source file with the extension that is specified as the -$CXXFILESUFFIX +$CXXFILESUFFIX variable. - _SWIGINCFLAGS - - + + _SWIGINCFLAGS + + An automatically-generated construction variable containing the SWIG command-line options for specifying directories to be searched for included files. -The value of $_SWIGINCFLAGS is created +The value of $_SWIGINCFLAGS is created by respectively prepending and appending -$SWIGINCPREFIX and $SWIGINCSUFFIX +$SWIGINCPREFIX and $SWIGINCSUFFIX to the beginning and end -of each directory in $SWIGPATH. +of each directory in $SWIGPATH. - SWIGINCPREFIX - - + + SWIGINCPREFIX + + The prefix used to specify an include directory on the SWIG command line. This will be prepended to the beginning of each directory -in the $SWIGPATH construction variable -when the $_SWIGINCFLAGS variable is automatically generated. +in the $SWIGPATH construction variable +when the $_SWIGINCFLAGS variable is automatically generated. - SWIGINCSUFFIX - - + + SWIGINCSUFFIX + + The suffix used to specify an include directory on the SWIG command line. This will be appended to the end of each directory -in the $SWIGPATH construction variable -when the $_SWIGINCFLAGS variable is automatically generated. +in the $SWIGPATH construction variable +when the $_SWIGINCFLAGS variable is automatically generated. - SWIGOUTDIR - - + + SWIGOUTDIR + + Specifies the output directory in which the scripting language wrapper and interface generator should place generated language-specific files. This will be used by SCons to identify -the files that will be generated by the swig call, +the files that will be generated by the swig call, and translated into the swig -outdir option on the command line. - SWIGPATH - - + + SWIGPATH + + The list of directories that the scripting language wrapper and interface generate will search for included files. The SWIG implicit dependency scanner will search these directories for include files. The default value is an empty list. - + Don't explicitly put include directory arguments in SWIGFLAGS; the result will be non-portable @@ -6917,96 +7520,102 @@ and the directories will not be searched by the dependency scanner. Note: directory names in SWIGPATH will be looked-up relative to the SConscript directory when they are used in a command. To force -scons +scons to look-up a directory relative to the root of the source tree use #: - + env = Environment(SWIGPATH='#/include') - + The directory look-up can also be forced using the -Dir() +Dir() function: - + include = Dir('include') env = Environment(SWIGPATH=include) - + The directory list will be added to command lines through the automatically-generated -$_SWIGINCFLAGS +$_SWIGINCFLAGS construction variable, which is constructed by respectively prepending and appending the values of the -$SWIGINCPREFIX and $SWIGINCSUFFIX +$SWIGINCPREFIX and $SWIGINCSUFFIX construction variables to the beginning and end -of each directory in $SWIGPATH. +of each directory in $SWIGPATH. Any command lines you define that need the SWIGPATH directory list should -include $_SWIGINCFLAGS: +include $_SWIGINCFLAGS: - + env = Environment(SWIGCOM="my_swig -o $TARGET $_SWIGINCFLAGS $SOURCES") - SWIGVERSION - - + + SWIGVERSION + + The version number of the SWIG tool. - TAR - - + + TAR + + The tar archiver. - TARCOM - - + + TARCOM + + The command line used to call the tar archiver. - TARCOMSTR - - + + TARCOMSTR + + The string displayed when archiving files using the tar archiver. -If this is not set, then $TARCOM (the command line) is displayed. +If this is not set, then $TARCOM (the command line) is displayed. - + env = Environment(TARCOMSTR = "Archiving $TARGET") - TARFLAGS - - + + TARFLAGS + + General options passed to the tar archiver. - TARGET - - + + TARGET + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7015,19 +7624,19 @@ for more information). - TARGET_ARCH - - + + 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 -$HOST_ARCH, or, if that is unset, to the architecture of the +$HOST_ARCH, or, if that is unset, to the architecture of the running machine's OS (note that the python build or architecture has no effect). This variable must be passed as an argument to the Environment() @@ -7039,7 +7648,7 @@ all installed MSVC's that support the TARGET_ARCH, selecting the latest version for use. - + Valid values for Windows are x86, arm, @@ -7058,9 +7667,10 @@ For example, if you want to compile 64-bit binaries, you would set - TARGET_OS - - + + TARGET_OS + + The name of the target operating system for the compiled objects created by this Environment. This defaults to the value of HOST_OS, and the user can override it. @@ -7069,9 +7679,10 @@ For example, if you want to compile 64-bit binaries, you would set - TARGETS - - + + TARGETS + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7080,27 +7691,30 @@ for more information). - TARSUFFIX - - + + TARSUFFIX + + The suffix used for tar file names. - TEMPFILEARGJOIN - - -The string (or character) to be used to join the arguments passed to TEMPFILE when command line exceeds the limit set by $MAXLINELENGTH. + + TEMPFILEARGJOIN + + +The string (or character) to be used to join the arguments passed to TEMPFILE when command line exceeds the limit set by $MAXLINELENGTH. The default value is a space. However for MSVC, MSLINK the default is a line seperator characters as defined by os.linesep. Note this value is used literally and not expanded by the subst logic. - TEMPFILEPREFIX - - + + TEMPFILEPREFIX + + The prefix for a temporary file used to store lines lines longer than $MAXLINELENGTH as operations which call out to a shell will fail @@ -7115,9 +7729,10 @@ or '-via' for ARM toolchain. - TEMPFILESUFFIX - - + + TEMPFILESUFFIX + + The suffix used for the temporary file name used for long command lines. The name should include the dot ('.') if one is wanted as @@ -7127,47 +7742,52 @@ The default is '.lnk'. - TEX - - + + TEX + + The TeX formatter and typesetter. - TEXCOM - - + + TEXCOM + + The command line used to call the TeX formatter and typesetter. - TEXCOMSTR - - + + TEXCOMSTR + + The string displayed when calling the TeX formatter and typesetter. -If this is not set, then $TEXCOM (the command line) is displayed. +If this is not set, then $TEXCOM (the command line) is displayed. - + env = Environment(TEXCOMSTR = "Building $TARGET from TeX input $SOURCES") - TEXFLAGS - - + + TEXFLAGS + + General options passed to the TeX formatter and typesetter. - TEXINPUTS - - + + TEXINPUTS + + List of directories that the LaTeX program will search for include directories. The LaTeX implicit dependency scanner will search these @@ -7176,36 +7796,40 @@ directories for \include and \import files. - TEXTFILEPREFIX - - -The prefix used for Textfile file names, -the null string by default. + + TEXTFILEPREFIX + + +The prefix used for Textfile file names, +an empty string by default. - TEXTFILESUFFIX - - -The suffix used for Textfile file names; + + TEXTFILESUFFIX + + +The suffix used for Textfile file names; .txt by default. - TOOLS - - + + TOOLS + + A list of the names of the Tool specifications that are part of this construction environment. - UNCHANGED_SOURCES - - + + UNCHANGED_SOURCES + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7214,9 +7838,10 @@ for more information). - UNCHANGED_TARGETS - - + + UNCHANGED_TARGETS + + A reserved variable name that may not be set or used in a construction environment. (See the manpage section "Variable Substitution" @@ -7225,9 +7850,10 @@ for more information). - VENDOR - - + + VENDOR + + The person or organization who supply the packaged software. This is used to fill in the Vendor: @@ -7239,69 +7865,127 @@ field in the controlling information for MSI packages. - VERSION - - + + VERSION + + The version of the project, specified as a string. + + + VSWHERE + + +Specify the location of vswhere.exe. + + + + The vswhere.exe executable is distributed with Microsoft Visual Studio and Build + Tools since the 2017 edition, but is also available standalone. + It provides full information about installations of 2017 and later editions. + With the argument, vswhere.exe can detect installations of the 2010 through 2015 + editions with limited data returned. +If VSWHERE is set, SCons will use that location. + + + Otherwise SCons will look in the following locations and set VSWHERE to the path of the first vswhere.exe +located. + + + +%ProgramFiles(x86)%\Microsoft Visual Studio\Installer +%ProgramFiles%\Microsoft Visual Studio\Installer +%ChocolateyInstall%\bin + + + + Note that VSWHERE must be set at the same time or prior to any of msvc, msvs , and/or mslink Tool being initialized. + + Either set it as follows + +env = Environment(VSWHERE='c:/my/path/to/vswhere') + + +or if your construction environment is created specifying an empty tools list +(or a list of tools which omits all of default, msvs, msvc, and mslink), +and also before env.Tool is called to ininitialize any of those tools: + + + env = Environment(tools=[]) + env['VSWHERE'] = r'c:/my/vswhere/install/location/vswhere.exe' + env.Tool('msvc') + env.Tool('mslink') + env.Tool('msvs') + + + + + - WIN32_INSERT_DEF - - -A deprecated synonym for $WINDOWS_INSERT_DEF. + + WIN32_INSERT_DEF + + +A deprecated synonym for $WINDOWS_INSERT_DEF. - WIN32DEFPREFIX - - -A deprecated synonym for $WINDOWSDEFPREFIX. + + WIN32DEFPREFIX + + +A deprecated synonym for $WINDOWSDEFPREFIX. - WIN32DEFSUFFIX - - -A deprecated synonym for $WINDOWSDEFSUFFIX. + + WIN32DEFSUFFIX + + +A deprecated synonym for $WINDOWSDEFSUFFIX. - WIN32EXPPREFIX - - -A deprecated synonym for $WINDOWSEXPSUFFIX. + + WIN32EXPPREFIX + + +A deprecated synonym for $WINDOWSEXPSUFFIX. - WIN32EXPSUFFIX - - -A deprecated synonym for $WINDOWSEXPSUFFIX. + + WIN32EXPSUFFIX + + +A deprecated synonym for $WINDOWSEXPSUFFIX. - WINDOWS_EMBED_MANIFEST - - + + WINDOWS_EMBED_MANIFEST + + Set this variable to True or 1 to embed the compiler-generated manifest (normally ${TARGET}.manifest) into all Windows exes and DLLs built with this environment, as a resource during their link step. -This is done using $MT and $MTEXECOM and $MTSHLIBCOM. +This is done using $MT and $MTEXECOM and $MTSHLIBCOM. - WINDOWS_INSERT_DEF - - + + WINDOWS_INSERT_DEF + + When this is set to true, a library build of a Windows shared library (.dll file) @@ -7314,11 +7998,12 @@ The default is 0 (do not build a .def file). - WINDOWS_INSERT_MANIFEST - - + + WINDOWS_INSERT_MANIFEST + + When this is set to true, -scons +scons will be aware of the .manifest files generated by Microsoft Visua C/C++ 8. @@ -7326,77 +8011,86 @@ files generated by Microsoft Visua C/C++ 8. - WINDOWSDEFPREFIX - - + + WINDOWSDEFPREFIX + + The prefix used for Windows .def file names. - WINDOWSDEFSUFFIX - - + + WINDOWSDEFSUFFIX + + The suffix used for Windows .def file names. - WINDOWSEXPPREFIX - - + + WINDOWSEXPPREFIX + + The prefix used for Windows .exp file names. - WINDOWSEXPSUFFIX - - + + WINDOWSEXPSUFFIX + + The suffix used for Windows .exp file names. - WINDOWSPROGMANIFESTPREFIX - - + + WINDOWSPROGMANIFESTPREFIX + + The prefix used for executable program .manifest files generated by Microsoft Visual C/C++. - WINDOWSPROGMANIFESTSUFFIX - - + + WINDOWSPROGMANIFESTSUFFIX + + The suffix used for executable program .manifest files generated by Microsoft Visual C/C++. - WINDOWSSHLIBMANIFESTPREFIX - - + + WINDOWSSHLIBMANIFESTPREFIX + + The prefix used for shared library .manifest files generated by Microsoft Visual C/C++. - WINDOWSSHLIBMANIFESTSUFFIX - - + + WINDOWSSHLIBMANIFESTSUFFIX + + The suffix used for shared library .manifest files generated by Microsoft Visual C/C++. - X_IPK_DEPENDS - - + + X_IPK_DEPENDS + + This is used to fill in the Depends: field in the controlling information for Ipkg packages. @@ -7404,9 +8098,10 @@ field in the controlling information for Ipkg packages. - X_IPK_DESCRIPTION - - + + X_IPK_DESCRIPTION + + This is used to fill in the Description: field in the controlling information for Ipkg packages. @@ -7416,9 +8111,10 @@ The default value is - X_IPK_MAINTAINER - - + + X_IPK_MAINTAINER + + This is used to fill in the Maintainer: field in the controlling information for Ipkg packages. @@ -7426,9 +8122,10 @@ field in the controlling information for Ipkg packages. - X_IPK_PRIORITY - - + + X_IPK_PRIORITY + + This is used to fill in the Priority: field in the controlling information for Ipkg packages. @@ -7436,9 +8133,10 @@ field in the controlling information for Ipkg packages. - X_IPK_SECTION - - + + X_IPK_SECTION + + This is used to fill in the Section: field in the controlling information for Ipkg packages. @@ -7446,9 +8144,10 @@ field in the controlling information for Ipkg packages. - X_MSI_LANGUAGE - - + + X_MSI_LANGUAGE + + This is used to fill in the Language: attribute in the controlling information for MSI packages. @@ -7456,9 +8155,10 @@ attribute in the controlling information for MSI packages. - X_MSI_LICENSE_TEXT - - + + X_MSI_LICENSE_TEXT + + The text of the software license in RTF format. Carriage return characters will be replaced with the RTF equivalent \\par. @@ -7466,17 +8166,19 @@ replaced with the RTF equivalent \\par. - X_MSI_UPGRADE_CODE - - + + X_MSI_UPGRADE_CODE + + TODO - X_RPM_AUTOREQPROV - - + + X_RPM_AUTOREQPROV + + This is used to fill in the AutoReqProv: field in the RPM @@ -7485,17 +8187,19 @@ field in the RPM - X_RPM_BUILD - - + + X_RPM_BUILD + + internal, but overridable - X_RPM_BUILDREQUIRES - - + + X_RPM_BUILDREQUIRES + + This is used to fill in the BuildRequires: field in the RPM @@ -7505,25 +8209,28 @@ Note this should only be used on a host managed by rpm as the dependencies will - X_RPM_BUILDROOT - - + + X_RPM_BUILDROOT + + internal, but overridable - X_RPM_CLEAN - - + + X_RPM_CLEAN + + internal, but overridable - X_RPM_CONFLICTS - - + + X_RPM_CONFLICTS + + This is used to fill in the Conflicts: field in the RPM @@ -7532,9 +8239,10 @@ field in the RPM - X_RPM_DEFATTR - - + + X_RPM_DEFATTR + + This value is used as the default attributes for the files in the RPM package. The default value is @@ -7543,9 +8251,10 @@ The default value is - X_RPM_DISTRIBUTION - - + + X_RPM_DISTRIBUTION + + This is used to fill in the Distribution: field in the RPM @@ -7554,9 +8263,10 @@ field in the RPM - X_RPM_EPOCH - - + + X_RPM_EPOCH + + This is used to fill in the Epoch: field in the RPM @@ -7565,9 +8275,10 @@ field in the RPM - X_RPM_EXCLUDEARCH - - + + X_RPM_EXCLUDEARCH + + This is used to fill in the ExcludeArch: field in the RPM @@ -7576,9 +8287,10 @@ field in the RPM - X_RPM_EXLUSIVEARCH - - + + X_RPM_EXLUSIVEARCH + + This is used to fill in the ExclusiveArch: field in the RPM @@ -7587,9 +8299,10 @@ field in the RPM - X_RPM_EXTRADEFS - - + + X_RPM_EXTRADEFS + + A list used to supply extra defintions or flags to be added to the RPM .spec file. Each item is added as-is with a carriage return appended. @@ -7605,23 +8318,25 @@ list that does not include the default line. Added in version 3.1. - + env.Package( - NAME = 'foo', -... - X_RPM_EXTRADEFS = [ - '%define _unpackaged_files_terminate_build 0' - '%define _missing_doc_files_terminate_build 0' + NAME="foo", + ... + X_RPM_EXTRADEFS=[ + "%define _unpackaged_files_terminate_build 0" + "%define _missing_doc_files_terminate_build 0" ], -... ) + ... +) - X_RPM_GROUP - - + + X_RPM_GROUP + + This is used to fill in the Group: field in the RPM @@ -7630,9 +8345,10 @@ field in the RPM - X_RPM_GROUP_lang - - + + X_RPM_GROUP_lang + + This is used to fill in the Group(lang): field in the RPM @@ -7646,9 +8362,10 @@ the appropriate language code. - X_RPM_ICON - - + + X_RPM_ICON + + This is used to fill in the Icon: field in the RPM @@ -7657,17 +8374,19 @@ field in the RPM - X_RPM_INSTALL - - + + X_RPM_INSTALL + + internal, but overridable - X_RPM_PACKAGER - - + + X_RPM_PACKAGER + + This is used to fill in the Packager: field in the RPM @@ -7676,9 +8395,10 @@ field in the RPM - X_RPM_POSTINSTALL - - + + X_RPM_POSTINSTALL + + This is used to fill in the %post: section in the RPM @@ -7687,9 +8407,10 @@ section in the RPM - X_RPM_POSTUNINSTALL - - + + X_RPM_POSTUNINSTALL + + This is used to fill in the %postun: section in the RPM @@ -7698,9 +8419,10 @@ section in the RPM - X_RPM_PREFIX - - + + X_RPM_PREFIX + + This is used to fill in the Prefix: field in the RPM @@ -7709,9 +8431,10 @@ field in the RPM - X_RPM_PREINSTALL - - + + X_RPM_PREINSTALL + + This is used to fill in the %pre: section in the RPM @@ -7720,17 +8443,19 @@ section in the RPM - X_RPM_PREP - - + + X_RPM_PREP + + internal, but overridable - X_RPM_PREUNINSTALL - - + + X_RPM_PREUNINSTALL + + This is used to fill in the %preun: section in the RPM @@ -7739,9 +8464,10 @@ section in the RPM - X_RPM_PROVIDES - - + + X_RPM_PROVIDES + + This is used to fill in the Provides: field in the RPM @@ -7750,9 +8476,10 @@ field in the RPM - X_RPM_REQUIRES - - + + X_RPM_REQUIRES + + This is used to fill in the Requires: field in the RPM @@ -7761,9 +8488,10 @@ field in the RPM - X_RPM_SERIAL - - + + X_RPM_SERIAL + + This is used to fill in the Serial: field in the RPM @@ -7772,9 +8500,10 @@ field in the RPM - X_RPM_URL - - + + X_RPM_URL + + This is used to fill in the Url: field in the RPM @@ -7783,118 +8512,130 @@ field in the RPM - XGETTEXT - - + + XGETTEXT + + Path to xgettext(1) program (found via Detect()). -See xgettext tool and POTUpdate builder. +See xgettext tool and POTUpdate builder. - XGETTEXTCOM - - + + XGETTEXTCOM + + Complete xgettext command line. -See xgettext tool and POTUpdate builder. +See xgettext tool and POTUpdate builder. - XGETTEXTCOMSTR - - + + XGETTEXTCOMSTR + + A string that is shown when xgettext(1) command is invoked -(default: '', which means "print $XGETTEXTCOM"). -See xgettext tool and POTUpdate builder. +(default: '', which means "print $XGETTEXTCOM"). +See xgettext tool and POTUpdate builder. - _XGETTEXTDOMAIN - - + + _XGETTEXTDOMAIN + + Internal "macro". Generates xgettext domain name form source and target (default: '${TARGET.filebase}'). - XGETTEXTFLAGS - - + + XGETTEXTFLAGS + + Additional flags to xgettext(1). -See xgettext tool and POTUpdate builder. +See xgettext tool and POTUpdate builder. - XGETTEXTFROM - - + + XGETTEXTFROM + + Name of file containing list of xgettext(1)'s source files. Autotools' users know this as POTFILES.in so they will in most cases set XGETTEXTFROM="POTFILES.in" here. -The $XGETTEXTFROM files have same syntax and semantics as the well known +The $XGETTEXTFROM files have same syntax and semantics as the well known GNU POTFILES.in. -See xgettext tool and POTUpdate builder. +See xgettext tool and POTUpdate builder. - _XGETTEXTFROMFLAGS - - + + _XGETTEXTFROMFLAGS + + Internal "macro". Genrates list of -D<dir> flags -from the $XGETTEXTPATH list. +from the $XGETTEXTPATH list. - XGETTEXTFROMPREFIX - - -This flag is used to add single $XGETTEXTFROM file to + + XGETTEXTFROMPREFIX + + +This flag is used to add single $XGETTEXTFROM file to xgettext(1)'s commandline (default: '-f'). - XGETTEXTFROMSUFFIX - - + + XGETTEXTFROMSUFFIX + + (default: '') - XGETTEXTPATH - - + + XGETTEXTPATH + + List of directories, there xgettext(1) will look for source files (default: []). -This variable works only together with $XGETTEXTFROM +This variable works only together with $XGETTEXTFROM -See also xgettext tool and POTUpdate builder. +See also xgettext tool and POTUpdate builder. - _XGETTEXTPATHFLAGS - - + + _XGETTEXTPATHFLAGS + + Internal "macro". Generates list of -f<file> flags -from $XGETTEXTFROM. +from $XGETTEXTFROM. - XGETTEXTPATHPREFIX - - + + XGETTEXTPATHPREFIX + + This flag is used to add single search path to xgettext(1)'s commandline (default: '-D'). @@ -7902,50 +8643,55 @@ This flag is used to add single search path to - XGETTEXTPATHSUFFIX - - + + XGETTEXTPATHSUFFIX + + (default: '') - YACC - - + + YACC + + The parser generator. - YACCCOM - - + + YACCCOM + + The command line used to call the parser generator to generate a source file. - YACCCOMSTR - - + + YACCCOMSTR + + The string displayed when generating a source file using the parser generator. -If this is not set, then $YACCCOM (the command line) is displayed. +If this is not set, then $YACCCOM (the command line) is displayed. - + env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES") - YACCFLAGS - - + + YACCFLAGS + + General options passed to the parser generator. -If $YACCFLAGS contains a option, +If $YACCFLAGS contains a option, SCons assumes that the call will also create a .h file (if the yacc source file ends in a .y suffix) or a .hpp file @@ -7954,9 +8700,10 @@ or a .hpp file - YACCHFILESUFFIX - - + + YACCHFILESUFFIX + + The suffix of the C header file generated by the parser generator when the @@ -7973,9 +8720,10 @@ The default value is - YACCHXXFILESUFFIX - - + + YACCHXXFILESUFFIX + + The suffix of the C++ header file generated by the parser generator when the @@ -7991,16 +8739,17 @@ The default value is except on Mac OS X, where the default is ${TARGET.suffix}.h. -because the default bison parser generator just +because the default bison parser generator just appends .h to the name of the generated C++ file. - YACCVCGFILESUFFIX - - + + YACCVCGFILESUFFIX + + The suffix of the file containing the VCG grammar automaton definition when the @@ -8017,17 +8766,19 @@ The default value is - ZIP - - + + ZIP + + The zip compression and file packaging utility. - ZIPCOM - - + + ZIPCOM + + The command line used to call the zip utility, or the internal Python function used to create a zip archive. @@ -8035,9 +8786,10 @@ zip archive. - ZIPCOMPRESSION - - + + ZIPCOMPRESSION + + The compression flag @@ -8056,43 +8808,46 @@ module is unavailable. - ZIPCOMSTR - - + + ZIPCOMSTR + + The string displayed when archiving files using the zip utility. -If this is not set, then $ZIPCOM +If this is not set, then $ZIPCOM (the command line or internal Python function) is displayed. - + env = Environment(ZIPCOMSTR = "Zipping $TARGET") - ZIPFLAGS - - + + ZIPFLAGS + + General options passed to the zip utility. - ZIPROOT - - + + ZIPROOT + + An optional zip root directory (default empty). The filenames stored in the zip file will be relative to this directory, if given. Otherwise the filenames are relative to the current directory of the command. For instance: - + env = Environment() env.Zip('foo.zip', 'subdir1/subdir2/file1', ZIPROOT='subdir1') - + will produce a zip file foo.zip containing a file with the name subdir2/file1 rather than @@ -8101,9 +8856,10 @@ containing a file with the name - ZIPSUFFIX - - + + ZIPSUFFIX + + The suffix used for zip file names. diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index ff44a23..a7aa197 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -10,10 +10,10 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $__LDMODULEVERSIONFLAGS"> $__SHLIBVERSIONFLAGS"> -$_APPLELINK_COMPATIBILITY_VERSION"> $APPLELINK_COMPATIBILITY_VERSION"> -$_APPLELINK_CURRENT_VERSION"> +$_APPLELINK_COMPATIBILITY_VERSION"> $APPLELINK_CURRENT_VERSION"> +$_APPLELINK_CURRENT_VERSION"> $APPLELINK_NO_COMPATIBILITY_VERSION"> $APPLELINK_NO_CURRENT_VERSION"> $AR"> @@ -201,8 +201,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $_FRAMEWORKPATH"> $FRAMEWORKPATHPREFIX"> $FRAMEWORKPREFIX"> -$_FRAMEWORKS"> $FRAMEWORKS"> +$_FRAMEWORKS"> $FRAMEWORKSFLAGS"> $GS"> $GSCOM"> @@ -259,8 +259,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $_LDMODULESONAME"> $LDMODULESUFFIX"> $LDMODULEVERSION"> -$LDMODULEVERSIONFLAGS"> $_LDMODULEVERSIONFLAGS"> +$LDMODULEVERSIONFLAGS"> $LEX"> $LEXCOM"> $LEXCOMSTR"> @@ -435,8 +435,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $RMICCOM"> $RMICCOMSTR"> $RMICFLAGS"> -$_RPATH"> $RPATH"> +$_RPATH"> $RPATHPREFIX"> $RPATHSUFFIX"> $RPCGEN"> @@ -562,6 +562,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $UNCHANGED_TARGETS"> $VENDOR"> $VERSION"> +$VSWHERE"> $WIN32_INSERT_DEF"> $WIN32DEFPREFIX"> $WIN32DEFSUFFIX"> @@ -653,10 +654,10 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $__LDMODULEVERSIONFLAGS"> $__SHLIBVERSIONFLAGS"> -$_APPLELINK_COMPATIBILITY_VERSION"> $APPLELINK_COMPATIBILITY_VERSION"> -$_APPLELINK_CURRENT_VERSION"> +$_APPLELINK_COMPATIBILITY_VERSION"> $APPLELINK_CURRENT_VERSION"> +$_APPLELINK_CURRENT_VERSION"> $APPLELINK_NO_COMPATIBILITY_VERSION"> $APPLELINK_NO_CURRENT_VERSION"> $AR"> @@ -844,8 +845,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $_FRAMEWORKPATH"> $FRAMEWORKPATHPREFIX"> $FRAMEWORKPREFIX"> -$_FRAMEWORKS"> $FRAMEWORKS"> +$_FRAMEWORKS"> $FRAMEWORKSFLAGS"> $GS"> $GSCOM"> @@ -902,8 +903,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $_LDMODULESONAME"> $LDMODULESUFFIX"> $LDMODULEVERSION"> -$LDMODULEVERSIONFLAGS"> $_LDMODULEVERSIONFLAGS"> +$LDMODULEVERSIONFLAGS"> $LEX"> $LEXCOM"> $LEXCOMSTR"> @@ -1078,8 +1079,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $RMICCOM"> $RMICCOMSTR"> $RMICFLAGS"> -$_RPATH"> $RPATH"> +$_RPATH"> $RPATHPREFIX"> $RPATHSUFFIX"> $RPCGEN"> @@ -1205,6 +1206,7 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $UNCHANGED_TARGETS"> $VENDOR"> $VERSION"> +$VSWHERE"> $WIN32_INSERT_DEF"> $WIN32DEFPREFIX"> $WIN32DEFSUFFIX"> diff --git a/doc/man/SConstruct b/doc/man/SConstruct index 927bfa2..4a2fabd 100644 --- a/doc/man/SConstruct +++ b/doc/man/SConstruct @@ -28,7 +28,7 @@ import os env = Environment(ENV={'PATH' : os.environ['PATH']}, tools=['docbook','gs','zip'], - toolpath=['../../src/engine/SCons/Tool'], + toolpath=['../../SCons/Tool'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') diff --git a/doc/man/epub.xsl b/doc/man/epub.xsl index a9851a0..f63849f 100644 --- a/doc/man/epub.xsl +++ b/doc/man/epub.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/man/html.xsl b/doc/man/html.xsl index d4f33da..c3d9175 100644 --- a/doc/man/html.xsl +++ b/doc/man/html.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/man/pdf.xsl b/doc/man/pdf.xsl index 5804774..baff08f 100644 --- a/doc/man/pdf.xsl +++ b/doc/man/pdf.xsl @@ -29,8 +29,9 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - - + + + diff --git a/doc/python10/SConstruct b/doc/python10/SConstruct index 4dc69b1..2928bda 100644 --- a/doc/python10/SConstruct +++ b/doc/python10/SConstruct @@ -28,7 +28,7 @@ import os env = Environment(ENV={'PATH' : os.environ['PATH']}, tools=['docbook'], - toolpath=['../../src/engine/SCons/Tool']) + toolpath=['../../SCons/Tool']) has_pdf = False if (env.WhereIs('fop') or diff --git a/doc/reference/SConstruct b/doc/reference/SConstruct index f8b472e..edc21a0 100644 --- a/doc/reference/SConstruct +++ b/doc/reference/SConstruct @@ -28,7 +28,7 @@ import os env = Environment(ENV={'PATH' : os.environ['PATH']}, tools=['docbook'], - toolpath=['../../src/engine/SCons/Tool'], + toolpath=['../../SCons/Tool'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') diff --git a/doc/reference/chtml.xsl b/doc/reference/chtml.xsl index d85874d..f0c9474 100644 --- a/doc/reference/chtml.xsl +++ b/doc/reference/chtml.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/reference/html.xsl b/doc/reference/html.xsl index 9efc458..4f2d383 100644 --- a/doc/reference/html.xsl +++ b/doc/reference/html.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/reference/pdf.xsl b/doc/reference/pdf.xsl index 33100d2..faea7fc 100644 --- a/doc/reference/pdf.xsl +++ b/doc/reference/pdf.xsl @@ -29,8 +29,9 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - - + + + diff --git a/doc/user/SConstruct b/doc/user/SConstruct index 701fb7b..4e96319 100644 --- a/doc/user/SConstruct +++ b/doc/user/SConstruct @@ -28,7 +28,7 @@ import os env = Environment(ENV={'PATH' : os.environ['PATH']}, tools=['docbook','gs','zip'], - toolpath=['../../src/engine/SCons/Tool'], + toolpath=['../../SCons/Tool'], DOCBOOK_DEFAULT_XSL_HTML='html.xsl', DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl', DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') diff --git a/doc/user/chtml.xsl b/doc/user/chtml.xsl index 06b3285..2abb823 100644 --- a/doc/user/chtml.xsl +++ b/doc/user/chtml.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/user/epub.xsl b/doc/user/epub.xsl index 6a33a63..892eae4 100644 --- a/doc/user/epub.xsl +++ b/doc/user/epub.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/user/html.xsl b/doc/user/html.xsl index 2cef43d..17c9f67 100644 --- a/doc/user/html.xsl +++ b/doc/user/html.xsl @@ -28,7 +28,7 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - + diff --git a/doc/user/pdf.xsl b/doc/user/pdf.xsl index c869664..c975f0e 100644 --- a/doc/user/pdf.xsl +++ b/doc/user/pdf.xsl @@ -29,8 +29,9 @@ xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> - - + + + -- cgit v0.12 From 5ba1ee02355ee0f69dd6e821116e098b83fdf6d8 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Fri, 8 May 2020 14:14:50 -0600 Subject: Some more adjustments to doc build [ci skip] other changes due to path changes rewording in doc howto rst check in the doc flow image used by the howto, as it's tricky to generate Signed-off-by: Mats Wichmann --- .gitattributes | 2 +- CHANGES.txt | 2 + doc/images/overview.png | Bin 0 -> 36232 bytes doc/overview.rst | 198 ++++++++++++++++++++++------------- testing/framework/test-framework.rst | 6 +- 5 files changed, 132 insertions(+), 76 deletions(-) create mode 100644 doc/images/overview.png diff --git a/.gitattributes b/.gitattributes index 54fb67f..8b807df 100644 --- a/.gitattributes +++ b/.gitattributes @@ -1,5 +1,5 @@ doc/* linguist-documentation -src/engine/SCons/Tool/docbook/docbook-xsl-1.76.1 linguist-vendored +SCons/Tool/docbook/docbook-xsl-1.76.1 linguist-vendored *.xml linguist-documentation *.xsl linguist-documentation *.gen linguist-documentation diff --git a/CHANGES.txt b/CHANGES.txt index 82809b9..61a9e1c 100755 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -136,6 +136,8 @@ RELEASE VERSION/DATE TO BE FILLED IN LATER a document with tostring(). - Fix description of ARCOMSTR constr. var. (issue 3636). Previously the text was a copy of ASCOMSTR which has different function. + - Update xml files in SCons to reflect changed relative paths after + code restructuring (src/engine/SCons -> SCons) diff --git a/doc/images/overview.png b/doc/images/overview.png new file mode 100644 index 0000000..f1189c9 Binary files /dev/null and b/doc/images/overview.png differ diff --git a/doc/overview.rst b/doc/overview.rst index 612fbba..aed27af 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -6,94 +6,128 @@ SCons Documentation Toolchain Introduction ============ -This text tries to give an overview of the current SCons documentation toolchain. -The interested user should be able to better understand where and how the text he writes -is processed. -It is also a reference for core developers and the release team. +This text tries to give an overview of the current SCons documentation +toolchain. As a prospective doc editor, you should be able to quickly +understand the basic concepts (if not, please let the project know how +it falls short). It is also a reference for core developers and the +release team. .. image:: images/overview.png -The diagram above roughly shows the steps that we currently need for creating all the MAN pages, User manuals and -reference documents. You may think: "Geeez, that looks so complicated. Why can't they -simply convert XML files to PDF with Docbook, or use reST?" Please be patient, and -continue reading. Things will get a little clearer soon. +The diagram above roughly shows the steps that we currently need for +creating all the MAN pages, User manuals and reference documents. You +may think: "Geeez, that looks so complicated. Why can't they simply +convert XML files to PDF with Docbook, or use reST?" Please be patient, +and continue reading. Things will get a little clearer soon. -Our toolchain doesn't only produce HTML and PDF files that are nice to look at, it also performs a lot -of processing under the covers. We try to have our documentation as consistent as possible to the -current behaviour of the source code, but this requires some extra steps. +Our toolchain doesn't only produce HTML and PDF files that are nice +to look at, it also performs a lot of processing under the covers. We +try to have our documentation as consistent as possible to the current +behaviour of the source code, but this requires some extra steps. So let's start right at the top... Writer's view ============= -The toolchain is set up, such that the User has a very restricted view on this whole "document -processing thingy". All he should be concerned about is to edit existing text or write new sections -and paragraphs. -Sometimes even a completely new chapter has to be added, in general he can fire up his XML editor of choice -and type away. +SCons documentation is written in Docbook (the xml variant). +The toolchain is set up so that a writer has a restricted view of the +whole "document processing thingy". All you should need to be concerned +with is to edit existing text or write new sections and paragraphs. +Sometimes even a completely new chapter has to be added. The hope +is that you can fire up your XML editor of choice and type away. -If he is a really nice user, he cares about validating his XML files against our special -"SCons Docbook DTD/XSD". Either during typing, supported by his XML editor, or by executing a special -script +XML is easy to get wrong, so you need to case about +validating the XML files +against our special "SCons Docbook DTD/XSD". You can run the +special script :: python bin/docs-validate.py -from the top source folder afterwards. Preferably both. +from the top source folder to validate. If you are able to use +an XML editor, many of the potential problems are avoided - +the most common error is not matching tag opening and closing +(for example ``foo`` is an easy typing error to make, +as is starting a ````, typing text, and not adding the +closing ````). XML editors make it much harder to make +those errors, which minor though they seem, will completely +break the document build. -Everything's looking okay, all validation passed? Good, then he simply commits his new work, and -creates a pull request on Bitbucket. That's it! +Everything's looking okay, all validation passed? Good, then simply +commits your new work, and create a pull request on Github. That's it! -Additionally, he can create the single documents on his side if he wants to get a feel for how the -final result looks (and who doesn't?). Each of the document folders (``design``, ``developer``, ``man``, -``python10``, ``reference``, and ``user``) contains an ``SConstruct`` file along with the actual -XML files. You can call +Additionally, you can create the single documents locally if you want +to get a feel for how the final result looks (and who doesn't?). Each of +the document folders (``design``, ``developer``, ``man``, ``python10``, +``reference``, and ``user``) contains an ``SConstruct`` file along with +the actual XML files. You can call :: - python ../../src/script/scons.py + python ../../scripts/scons.py -from within the directory, and have the MAN pages or HTML created...even PDF, if you have a -renderer installed (``fop``, ``xep`` or ``jw``). +from within the directory, and have the MAN pages or HTML created...even +PDF, if you have a renderer installed (``fop``, ``xep`` or ``jw``). Validation ========== -Just a few more words about the validation step. -We are using our own DTD/XSD as a kind of hook, which only exists to link our own -SCons documentation tags into the normal Docbook XSD. For the output, we always -have an intermediary step (see diagram above), where we rewrite tags like ``cvar`` -into a block of Docbook formatting elements representing it. +Just a few more words about the validation step. We are using our +own DTD/XSD as a kind of hook, which only exists to link our own SCons +documentation tags into the normal Docbook XSD. For the output, we always +have an intermediary step (see diagram above), where we rewrite tags like +``cvar`` into a block of Docbook formatting elements representing it. -The toolchain, and all the Python scripts supporting it, are based on the prerequisite that -all documents are valid against the SCons Docbook XSD. This step guarantees that we can -accept the pull request of a user/writer with all his changes, and can create the documentation +The toolchain, and all the Python scripts supporting it, are based +on the prerequisite that all documents are valid against the SCons +Docbook XSD. This step guarantees that we can accept the pull request +of a user/writer with all his changes, and can create the documentation for a new release of SCons without any problems at a later time. Entities ======== -We are using entities for special keywords like ``SCons`` that should appear with the same -formatting throughout the text. These are kept in a single file ``doc/scons.mod`` which gets -included by the documents. +We are using entities for special keywords like ``SCons`` that should +appear with the same formatting throughout the text. These are kept in +a single file ``doc/scons.mod`` which gets included by the documents. -Additionally, for each Tool, Builder, Cvar and Function, a bunch of linkends in the form of -entities get defined. They can be used in the MAN page and the User manual. +Additionally, for each Tool, Builder, Cvar (construction variable) and +Function, a bunch of linkends in the form of entities get defined. They +can be used in the MAN page and the User manual. + +When you add an XML file in the ``SCons/Tools`` folder, e.g. for +a tool named ``foobar``, you can use the two entities -When you add an XML file in the ``src/engine/Tools`` folder, e.g. for a tool named ``foobar``, -you can use the two entities - *t-foobar* which prints the name of the Tool, and - + *t-link-foobar* - which is a link to the description of the Tool in the Appendix - -of the User guide's text. + which is a link to the description of the Tool + +The link will be to the appropriate Appendix in the User Guide, +or to the proper section in the manpage. + +In the case of Functions, there may be pairs of these, depending +on the value of the signature attribute: this attribute tells +whether only the global function form, or only the environment +method form, or both, exist. If all four exist you will get: + +*f-foobar* + which prints the name of the global Function + +*f-env-foobar* + which prints the name of the environment method + +*f-link-foobar* + which is a link to the description of the global Function + +*f-env-link-foobar* + which is a link to the description of the environment method + By calling the script @@ -101,26 +135,32 @@ By calling the script python bin/docs-update-generated.py -you can recreate the lists of entities (``*.mod``) in the ``generated`` folder, if required. -At the same time, this will generate the ``*.gen`` files, which list the full -description of all the Builders, Tools, Functions and CVars for the MAN page -and the guide's appendix. +you can recreate the lists of entities (``*.mod``) in the ``generated`` +folder, if required. At the same time, this will generate the ``*.gen`` +files, which list the full description of all the Builders, Tools, +Functions and CVars for the MAN page and the User Guide's appendix. +Thus, you want to regenerate when there's a change to +any of those four special elements, or an added or deleted element. +These generated files are left checked in so in the normal case you +can just rebuild the docs without having to first generate the entity +files. -For more information about how to properly describe these elements, refer to -the start of the Python script ``bin/SConsDoc.py``. It explains the available -tags and the exact syntax in detail. +For more information about how to properly describe these elements, +refer to the start of the Python script ``bin/SConsDoc.py``. It explains +the available tags and the exact syntax in detail. Examples ======== -In the User Guide, we support automatically created examples. This means that the output of the specified -source files and SConstructs, is generated by running them with the current SCons version. -We do this to ensure that the output displayed in the manual, is identical to what you get when you run -the example on the command-line. +In the User Guide, we support automatically created examples. This +means that the output of the specified source files and SConstructs +is generated by running them with the current SCons version. We do this +to ensure that the output displayed in the manual is identical to what +you get when you run the example on the command-line. -A short description about how these examples have to be defined, can be found at the start of the file -``bin/SConsExamples.py``. Call +A short description about how these examples have to be defined can be +found at the start of the file ``bin/SConsExamples.py``. Call :: @@ -128,24 +168,38 @@ A short description about how these examples have to be defined, can be found at from the top level source folder, to run all examples through SCons. -Before this script starts to generate any output, it checks whether the names of all defined examples are -unique. Another important prerequisite is, that for every example all the single ``scons_output`` blocks need to have -a ``suffix`` attribute defined. These suffixes also have to be unique, within each example. +Before this script starts to generate any output, it checks whether the +names of all defined examples are unique. Another important prerequisite +is that for every example all the single ``scons_output`` blocks need +to have a ``suffix`` attribute defined. These suffixes also have to be +unique, within each example. + +All example output files (``*.xml``) get written to the folder +``doc/generated/examples``, together with all files defined via the +``scons_example_file`` tag. They are put under version control, in +part so that the version control system can show any unexpected +changes in the outputs after editing the docs: -All example output files (``*.xml``) get written to the folder ``doc/generated/examples``, together with all files defined -via the ``scons_example_file`` tag. They are put under version control, too. Like this, it is easier to compare -whether the output got broken for a new version of SCons. +:: + git diff doc/generated/examples -Note, that these output files are not actually needed for editing the documents. When loading the User manual into an XML -editor, you will always see the example's definition. Only when you create some output, the files from -``doc/generated/examples`` get XIncluded and all special ``scons*`` tags are transformed into Docbook elements. +Note that these output files are not actually needed for editing the +documents. When loading the User manual into an XML editor, you will +always see the example's definition. Only when you create some output, +the files from ``doc/generated/examples`` get XIncluded and all special +``scons*`` tags are transformed into Docbook elements. Directories =========== Documents are in the folders ``design``, ``developer``, ``man``, -``python10``, ``reference``, and ``user``. +``python10``, ``reference``, and ``user``. Note that of these, +only ``man`` and ``user`` are actively maintained and some of +the others are vastly out of date. If submitting a github +Pull Request for a new SCons feature, you will only be required +to update the documentation that goes into the manpage and the +User Guide. *editor_configs* Prepared configuration sets for the validating WYSIWYG XML editors diff --git a/testing/framework/test-framework.rst b/testing/framework/test-framework.rst index 16d3734..8cac1fb 100644 --- a/testing/framework/test-framework.rst +++ b/testing/framework/test-framework.rst @@ -31,8 +31,8 @@ There are three types of SCons tests: *Unit Tests* Unit tests for individual SCons modules live underneath the - ``src/engine/`` subdirectory and are the same base name as the module - to be tests, with ``Tests`` appended before the ``.py``. For example, + ``SCons/`` subdirectory and are the same base name as the module + to be tested, with ``Tests`` appended to the basename. For example, the unit tests for the ``Builder.py`` module are in the ``BuilderTests.py`` script. Unit tests tend to be based on assertions. @@ -110,7 +110,7 @@ to be more silent, have a look at the ``-q``, ``-s`` and ``-k`` options. You may specifically list one or more tests to be run:: - $ python runtest.py src/engine/SCons/BuilderTests.py + $ python runtest.py SCons/BuilderTests.py $ python runtest.py test/option-j.py test/Program.py Folder names are allowed in the test list as well, so you can do:: -- cgit v0.12 From 5f0548f83fea72c7d7bf431f320e717547fa30b4 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Sun, 10 May 2020 07:05:59 -0600 Subject: docs src-move: remove debug prints [ci skip] accidentally left print statements in bin/scons-proc.py rebased to current master, which caused a couple of generated file changes. Signed-off-by: Mats Wichmann --- bin/scons-proc.py | 2 -- doc/generated/examples/caching_ex-random_1.xml | 4 ++-- doc/generated/tools.gen | 8 +++++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/bin/scons-proc.py b/bin/scons-proc.py index e4b73a2..30832a0 100644 --- a/bin/scons-proc.py +++ b/bin/scons-proc.py @@ -115,8 +115,6 @@ class SCons_XML(object): self.write_mod(mod) def write_gen(self, filename): - print(f"DEBUG: write_gen({filename})") - print(f"values={self.values}") if not filename: return # Try to split off .gen filename diff --git a/doc/generated/examples/caching_ex-random_1.xml b/doc/generated/examples/caching_ex-random_1.xml index 52ad77d..16a90be 100644 --- a/doc/generated/examples/caching_ex-random_1.xml +++ b/doc/generated/examples/caching_ex-random_1.xml @@ -1,8 +1,8 @@ % scons -Q -cc -o f3.o -c f3.c -cc -o f2.o -c f2.c cc -o f1.o -c f1.c cc -o f5.o -c f5.c +cc -o f3.o -c f3.c +cc -o f2.o -c f2.c cc -o f4.o -c f4.c cc -o prog f1.o f2.o f3.o f4.o f5.o diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index e81eb09..87140b0 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -830,10 +830,12 @@ Sets construction variables for the pdftex utility. python -Loads the Python scanner scanner into the invoking environment. When loaded, the scanner will -attempt to find implicit dependencies for any Python source files in the list of sources -provided to an actual that uses this environment. +Loads the Python source scanner into the invoking environment. +When loaded, the scanner will attempt to find implicit +dependencies for any Python source files in the list of sources +provided to an Action that uses this environment. +Available since scons 4.0.. -- cgit v0.12 From baa4f2d9d14d21195688bbba76647959d0032f03 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Mon, 11 May 2020 09:13:46 -0600 Subject: doc generation: fix another src->SCons transition Another regen of generated files, as there were a couple of changes that affected those. Signed-off-by: Mats Wichmann --- bin/docs-update-generated.py | 20 ++++---- bin/scons-proc.py | 18 ++++--- doc/generated/builders.gen | 110 +++++++++++++++++++++---------------------- doc/generated/builders.mod | 10 +--- doc/generated/functions.mod | 10 +--- doc/generated/tools.mod | 10 +--- doc/generated/variables.mod | 10 +--- 7 files changed, 79 insertions(+), 109 deletions(-) diff --git a/bin/docs-update-generated.py b/bin/docs-update-generated.py index e26655a..3687896 100644 --- a/bin/docs-update-generated.py +++ b/bin/docs-update-generated.py @@ -23,7 +23,7 @@ def argpair(key): return arg def generate_all(): - """ Scan for XML files in the src directory and call scons-proc.py + """ Scan for XML files in the SCons directory and call scons-proc.py to generate the *.gen/*.mod files from it. """ flist = [] @@ -43,13 +43,17 @@ def generate_all(): print("Couldn't create destination folder %s! Exiting..." % gen_folder) return # Call scons-proc.py - cp = subprocess.run([sys.executable, - os.path.join('bin','scons-proc.py'), - '-b', argpair('builders'), - '-f', argpair('functions'), - '-t', argpair('tools'), - '-v', argpair('variables')] + flist, - shell=False) + cp = subprocess.run( + [ + sys.executable, + os.path.join('bin', 'scons-proc.py'), + '-b', argpair('builders'), + '-f', argpair('functions'), + '-t', argpair('tools'), + '-v', argpair('variables'), + ] + flist, + shell=False, + ) # No-op: scons-proc doesn't actually set an exit code at the moment. if cp.returncode: diff --git a/bin/scons-proc.py b/bin/scons-proc.py index 30832a0..9ec4efd 100644 --- a/bin/scons-proc.py +++ b/bin/scons-proc.py @@ -93,12 +93,12 @@ Regular_Entities_Header = """\ Link_Entities_Header = """\ """ -class SCons_XML(object): +class SCons_XML: def __init__(self, entries, **kw): self.values = entries for k, v in kw.items(): @@ -206,8 +206,6 @@ class SCons_XML(object): (v.prefix, v.idfunc(), v.tag, SConsDoc.dbxsd, v.entityfunc(), v.tag)) f.write('\n') - f.write(Warning) - f.write('\n') f.write(Link_Entities_Header % description) f.write('\n') for v in self.values: @@ -222,8 +220,6 @@ class SCons_XML(object): (v.prefix, v.idfunc(), v.prefix, v.idfunc(), SConsDoc.dbxsd, v.tag, v.entityfunc(), v.tag)) - f.write('\n') - f.write(Warning) f.close() class Proxy(object): @@ -232,8 +228,10 @@ class Proxy(object): self.__subject = subject def __getattr__(self, name): - """Retrieve an attribute from the wrapped object. If the named - attribute doesn't exist, AttributeError is raised""" + """Retrieve an attribute from the wrapped object. + + If the named attribute doesn't exist, AttributeError is raised + """ return getattr(self.__subject, name) def get(self): @@ -279,7 +277,7 @@ class Builder(SConsThing): # build term for env. method mterm = stf.newNode("term") - inst = stf.newSubNode(mterm, "parameter") + inst = stf.newSubNode(mterm, "replaceable") stf.setText(inst, "env") stf.setTail(inst, ".") # we could use here, but it's a "method" @@ -415,7 +413,7 @@ write_output_files(h, buildersfiles, functionsfiles, toolsfiles, # Step 2: Validating all input files print("Validating files against SCons XSD...") -if SConsDoc.validate_all_xml(['src']): +if SConsDoc.validate_all_xml(['SCons']): print("OK") else: print("Validation failed! Please correct the errors above and try again.") diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 20e5215..f115e5b 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -14,7 +14,7 @@ CFile() - env.CFile() + env.CFile() Builds a C source file given a lex (.l) or yacc (.y) input file. @@ -35,7 +35,7 @@ env.CFile(target = 'bar', source = 'bar.y') Command() - env.Command() + env.Command() The Command "Builder" is actually a function that looks like a Builder, @@ -52,7 +52,7 @@ for the calling syntax and details. CXXFile() - env.CXXFile() + env.CXXFile() Builds a C++ source file given a lex (.ll) or yacc (.yy) @@ -74,7 +74,7 @@ env.CXXFile(target = 'bar', source = 'bar.yy') DocbookEpub() - env.DocbookEpub() + env.DocbookEpub() A pseudo-Builder, providing a Docbook toolchain for EPUB output. @@ -95,7 +95,7 @@ env.DocbookEpub('manual') DocbookHtml() - env.DocbookHtml() + env.DocbookHtml() A pseudo-Builder, providing a Docbook toolchain for HTML output. @@ -112,7 +112,7 @@ env.DocbookHtml('manual') DocbookHtmlChunked() - env.DocbookHtmlChunked() + env.DocbookHtmlChunked() A pseudo-Builder, providing a Docbook toolchain for chunked HTML output. It supports the base.dir parameter. The @@ -147,7 +147,7 @@ your files get renamed only! DocbookHtmlhelp() - env.DocbookHtmlhelp() + env.DocbookHtmlhelp() A pseudo-Builder, providing a Docbook toolchain for HTMLHELP output. Its basic syntax is: @@ -183,7 +183,7 @@ your files get renamed only! DocbookMan() - env.DocbookMan() + env.DocbookMan() A pseudo-Builder, providing a Docbook toolchain for Man page output. Its basic syntax is: @@ -201,7 +201,7 @@ set from the refname entries in your XML source. DocbookPdf() - env.DocbookPdf() + env.DocbookPdf() A pseudo-Builder, providing a Docbook toolchain for PDF output. @@ -222,7 +222,7 @@ env.DocbookPdf('manual') DocbookSlidesHtml() - env.DocbookSlidesHtml() + env.DocbookSlidesHtml() A pseudo-Builder, providing a Docbook toolchain for HTML slides output. @@ -256,7 +256,7 @@ your files get renamed only! DocbookSlidesPdf() - env.DocbookSlidesPdf() + env.DocbookSlidesPdf() A pseudo-Builder, providing a Docbook toolchain for PDF slides output. @@ -276,7 +276,7 @@ env.DocbookSlidesPdf('manual') DocbookXInclude() - env.DocbookXInclude() + env.DocbookXInclude() A pseudo-Builder, for resolving XIncludes in a separate processing step. @@ -288,7 +288,7 @@ env.DocbookXInclude('manual_xincluded.xml', 'manual.xml') DocbookXslt() - env.DocbookXslt() + env.DocbookXslt() A pseudo-Builder, applying a given XSL transformation to the input file. @@ -304,7 +304,7 @@ to be set. DVI() - env.DVI() + env.DVI() Builds a .dvi file from a .tex, @@ -358,7 +358,7 @@ env.DVI(target = 'ccc.dvi', source = 'ccc.latex') Gs() - env.Gs() + env.Gs() A Builder for explicitly calling the gs executable. Depending on the underlying OS, the different names gs, @@ -374,7 +374,7 @@ env.Gs('cover.jpg','scons-scons.pdf', Install() - env.Install() + env.Install() Installs one or more source files or directories in the specified target, @@ -422,7 +422,7 @@ and the chapters on Installing Files and on Alias Targets). InstallAs() - env.InstallAs() + env.InstallAs() Installs one or more source files or directories to specific names, @@ -450,7 +450,7 @@ See the note under Install. InstallVersionedLib() - env.InstallVersionedLib() + env.InstallVersionedLib() Installs a versioned shared library. The symlinks appropriate to the architecture will be generated based on symlinks of the source library. @@ -469,7 +469,7 @@ See the note under Install. Jar() - env.Jar() + env.Jar() Builds a Java archive (.jar) file from the specified list of sources. @@ -513,7 +513,7 @@ env.Jar(target = 'bar.jar', Java() - env.Java() + env.Java() Builds one or more Java class files. The sources may be any combination of explicit @@ -588,7 +588,7 @@ env['ENV']['LANG'] = 'en_GB.UTF-8' JavaH() - env.JavaH() + env.JavaH() Builds C header and source files for implementing Java native methods. @@ -640,7 +640,7 @@ env.JavaH( Library() - env.Library() + env.Library() A synonym for the StaticLibrary @@ -650,7 +650,7 @@ builder method. LoadableModule() - env.LoadableModule() + env.LoadableModule() On most systems, this is the same as @@ -662,7 +662,7 @@ this creates a loadable module bundle. M4() - env.M4() + env.M4() Builds an output file from an M4 input file. This uses a default $M4FLAGS value of @@ -680,7 +680,7 @@ env.M4(target = 'foo.c', source = 'foo.c.m4') Moc() - env.Moc() + env.Moc() Builds an output file from a moc input file. Moc input files are either header files or cxx files. This builder is only available after using the @@ -696,7 +696,7 @@ env.Moc('foo.cpp') # generates foo.moc MOFiles() - env.MOFiles() + env.MOFiles() This builder belongs to msgfmt tool. The builder compiles PO files to MO files. @@ -746,7 +746,7 @@ Compile files for languages defined in LINGUAS file MSVSProject() - env.MSVSProject() + env.MSVSProject() Builds a Microsoft Visual Studio project file, and by default builds a solution file as well. @@ -1100,7 +1100,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], MSVSSolution() - env.MSVSSolution() + env.MSVSSolution() Builds a Microsoft Visual Studio solution file. This builds a Visual Studio solution file, based on the @@ -1161,7 +1161,7 @@ env.MSVSSolution( Object() - env.Object() + env.Object() A synonym for the StaticObject @@ -1171,7 +1171,7 @@ builder method. Package() - env.Package() + env.Package() Builds a Binary Package of the given source files. @@ -1246,7 +1246,7 @@ env.Package( PCH() - env.PCH() + env.PCH() Builds a Microsoft Visual C++ precompiled header. Calling this builder method @@ -1266,7 +1266,7 @@ env['PCH'] = env.PCH('StdAfx.cpp')[0] PDF() - env.PDF() + env.PDF() Builds a .pdf file from a .dvi input file @@ -1290,7 +1290,7 @@ env.PDF(target = 'bbb', source = 'bbb.dvi') POInit() - env.POInit() + env.POInit() This builder belongs to msginit tool. The builder initializes missing PO file(s) if $POAUTOINIT is set. If @@ -1391,7 +1391,7 @@ which has same efect as: PostScript() - env.PostScript() + env.PostScript() Builds a .ps file from a .dvi input file @@ -1415,7 +1415,7 @@ env.PostScript(target = 'bbb', source = 'bbb.dvi') POTUpdate() - env.POTUpdate() + env.POTUpdate() The builder belongs to xgettext tool. The builder updates target POT file if exists or creates one if it doesn't. The node is @@ -1580,7 +1580,7 @@ then the messages.pot will contain POUpdate() - env.POUpdate() + env.POUpdate() The builder belongs to msgmerge tool. The builder updates PO files with msgmerge(1), or initializes @@ -1692,7 +1692,7 @@ pre-configured via environment. Program() - env.Program() + env.Program() Builds an executable given one or more object files or C, C++, D, or Fortran source files. @@ -1721,7 +1721,7 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) ProgramAllAtOnce() - env.ProgramAllAtOnce() + env.ProgramAllAtOnce() Builds an executable from D sources without first creating individual objects for each file. @@ -1747,7 +1747,7 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) RES() - env.RES() + env.RES() Builds a Microsoft Visual C++ resource file. This builder method is only provided @@ -1768,7 +1768,7 @@ env.RES('resource.rc') RMIC() - env.RMIC() + env.RMIC() Builds stub and skeleton class files for remote objects @@ -1810,7 +1810,7 @@ env.RMIC(target = 'outdir3', RPCGenClient() - env.RPCGenClient() + env.RPCGenClient() Generates an RPC client stub (_clnt.c) file from a specified RPC (.x) source file. @@ -1828,7 +1828,7 @@ env.RPCGenClient('src/rpcif.x') RPCGenHeader() - env.RPCGenHeader() + env.RPCGenHeader() Generates an RPC header (.h) file from a specified RPC (.x) source file. @@ -1846,7 +1846,7 @@ env.RPCGenHeader('src/rpcif.x') RPCGenService() - env.RPCGenService() + env.RPCGenService() Generates an RPC server-skeleton (_svc.c) file from a specified RPC (.x) source file. @@ -1864,7 +1864,7 @@ env.RPCGenClient('src/rpcif.x') RPCGenXDR() - env.RPCGenXDR() + env.RPCGenXDR() Generates an RPC XDR routine (_xdr.c) file from a specified RPC (.x) source file. @@ -1882,7 +1882,7 @@ env.RPCGenClient('src/rpcif.x') SharedLibrary() - env.SharedLibrary() + env.SharedLibrary() Builds a shared library (.so on a POSIX system, @@ -1999,7 +1999,7 @@ when it is done linking it. SharedObject() - env.SharedObject() + env.SharedObject() Builds an object file for inclusion in a shared library. @@ -2046,7 +2046,7 @@ below, for more information. StaticLibrary() - env.StaticLibrary() + env.StaticLibrary() Builds a static library given one or more object files or C, C++, D or Fortran source files. @@ -2085,7 +2085,7 @@ will raise an error if there is any mismatch. StaticObject() - env.StaticObject() + env.StaticObject() Builds a static object file from one or more C, C++, D, or Fortran source files. @@ -2152,7 +2152,7 @@ below, for more information. Substfile() - env.Substfile() + env.Substfile() The Substfile builder creates a single text file from another file or set of files by concatenating them with $LINESEPARATOR and replacing text @@ -2237,7 +2237,7 @@ subst.Substfile('pgm2.c', [Value('#include "@foo@.h"'), Tar() - env.Tar() + env.Tar() Builds a tar archive of the specified files and/or directories. @@ -2278,7 +2278,7 @@ env.Tar('foo') Textfile() - env.Textfile() + env.Textfile() The Textfile builder generates a single text file. The source strings constitute the lines; @@ -2344,7 +2344,7 @@ blob.txt Translate() - env.Translate() + env.Translate() This pseudo-builder belongs to gettext toolset. The builder extracts internationalized messages from source files, updates POT @@ -2477,7 +2477,7 @@ running scons '.'. TypeLibrary() - env.TypeLibrary() + env.TypeLibrary() Builds a Windows type library (.tlb) file from an input IDL file (.idl). @@ -2504,7 +2504,7 @@ files. Uic() - env.Uic() + env.Uic() Builds a header file, an implementation file and a moc file from an ui file. and returns the corresponding nodes in the above order. @@ -2528,7 +2528,7 @@ env.Uic(target = Split('include/foo.h gen/uicfoo.cc gen/mocfoo.cc'), Zip() - env.Zip() + env.Zip() Builds a zip archive of the specified files and/or directories. diff --git a/doc/generated/builders.mod b/doc/generated/builders.mod index ae60653..c4265d1 100644 --- a/doc/generated/builders.mod +++ b/doc/generated/builders.mod @@ -121,12 +121,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. env.Zip"> - - @@ -241,7 +237,3 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. env.TypeLibrary"> env.Uic"> env.Zip"> - - diff --git a/doc/generated/functions.mod b/doc/generated/functions.mod index 9ff02a0..2e355f0 100644 --- a/doc/generated/functions.mod +++ b/doc/generated/functions.mod @@ -171,12 +171,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. env.WhereIs"> - - @@ -341,7 +337,3 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. env.Value"> env.VariantDir"> env.WhereIs"> - - diff --git a/doc/generated/tools.mod b/doc/generated/tools.mod index 3f8e22a..0920ce0 100644 --- a/doc/generated/tools.mod +++ b/doc/generated/tools.mod @@ -108,12 +108,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. zip"> - - @@ -215,7 +211,3 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. xgettext"> yacc"> zip"> - - diff --git a/doc/generated/variables.mod b/doc/generated/variables.mod index a7aa197..e4a798b 100644 --- a/doc/generated/variables.mod +++ b/doc/generated/variables.mod @@ -643,12 +643,8 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $ZIPSUFFIX"> - - @@ -1285,7 +1281,3 @@ THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. $ZIPFLAGS"> $ZIPROOT"> $ZIPSUFFIX"> - - -- cgit v0.12