From 35590bd990f2fe28a4d39f41155d9020fffe096d Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Tue, 9 Jun 2020 16:49:00 +0200 Subject: First set of changes, started to rip out libxslt2. --- SCons/Tool/docbook/__init__.py | 180 +++--------- bin/SConsDoc.py | 571 ++++++++++--------------------------- bin/SConsExamples.py | 1 + bin/docs-create-example-outputs.py | 1 + bin/docs-update-generated.py | 1 + bin/docs-validate.py | 1 + bin/scons-proc.py | 30 +- 7 files changed, 209 insertions(+), 576 deletions(-) diff --git a/SCons/Tool/docbook/__init__.py b/SCons/Tool/docbook/__init__.py index 7f47e9d..3b725da 100644 --- a/SCons/Tool/docbook/__init__.py +++ b/SCons/Tool/docbook/__init__.py @@ -51,20 +51,14 @@ scriptpath = os.path.dirname(os.path.realpath(__file__)) # Local folder for the collection of DocBook XSLs db_xsl_folder = 'docbook-xsl-1.76.1' -# Do we have libxml2/libxslt/lxml? -has_libxml2 = True +# Do we have lxml? has_lxml = True try: - import libxml2 - import libxslt -except: - has_libxml2 = False -try: import lxml except: has_lxml = False -# Set this to True, to prefer xsltproc over libxml2 and lxml +# Set this to True, to prefer xsltproc over lxml prefer_xsltproc = False # Regexs for parsing Docbook XML sources of MAN pages @@ -95,20 +89,12 @@ def __init_xsl_stylesheet(kw, env, user_xsl_var, default_path): xsl_style = os.path.join(*path_args) kw['DOCBOOK_XSL'] = xsl_style -def __select_builder(lxml_builder, libxml2_builder, cmdline_builder): +def __select_builder(lxml_builder, cmdline_builder): """ Selects a builder, based on which Python modules are present. """ - if prefer_xsltproc: - return cmdline_builder - - if not has_libxml2: - # At the moment we prefer libxml2 over lxml, the latter can lead - # to conflicts when installed together with libxml2. - if has_lxml: - return lxml_builder - else: - return cmdline_builder + if has_lxml and not prefer_xsltproc: + return lxml_builder - return libxml2_builder + return cmdline_builder def __ensure_suffix(t, suffix): """ Ensure that the target t has the given suffix. """ @@ -207,7 +193,7 @@ def _detect(env): if env.get('DOCBOOK_PREFER_XSLTPROC',''): prefer_xsltproc = True - if (not has_libxml2 and not has_lxml) or prefer_xsltproc: + if (not has_lxml) or prefer_xsltproc: # Try to find the XSLT processors __detect_cl_tool(env, 'DOCBOOK_XSLTPROC', xsltproc_com, xsltproc_com_priority) __detect_cl_tool(env, 'DOCBOOK_XMLLINT', xmllint_com) @@ -233,44 +219,26 @@ def __xml_scan(node, env, path, arg): return sentity_re.findall(contents) xsl_file = os.path.join(scriptpath,'utils','xmldepend.xsl') - if not has_libxml2 or prefer_xsltproc: - if has_lxml and not prefer_xsltproc: - - from lxml import etree - - xsl_tree = etree.parse(xsl_file) - doc = etree.parse(str(node)) - result = doc.xslt(xsl_tree) - + if not has_lxml or prefer_xsltproc: + # Try to call xsltproc + xsltproc = env.subst("$DOCBOOK_XSLTPROC") + if xsltproc and xsltproc.endswith('xsltproc'): + result = env.backtick(' '.join([xsltproc, xsl_file, str(node)])) depfiles = [x.strip() for x in str(result).splitlines() if x.strip() != "" and not x.startswith("", dt.createDoctype()) - fp.write(content) - doc.freeDoc() - - @staticmethod - def writeTree(root, fpath): - with open(fpath, 'wb') as fp: - doc = libxml2.newDoc('1.0') - doc.setRootElement(root) - fp.write(doc.serialize("UTF-8", 1)) - doc.freeDoc() - - @staticmethod - def prettyPrintFile(fpath): - # Read file and resolve entities - doc = libxml2.readFile(fpath, None, libxml2d.XML_PARSE_NOENT) - with open(fpath, 'wb') as fp: - # Prettyprint - fp.write(doc.serialize("UTF-8", 1)) - # Cleanup - doc.freeDoc() - - @staticmethod - def decorateWithHeader(root): - # Register the namespaces - ns = root.newNs(dbxsd, None) - xi = root.newNs(xsi, 'xsi') - root.setNs(ns) #put this node in the target namespace - - root.setNsProp(xi, 'schemaLocation', "%s %s/scons.xsd" % (dbxsd, dbxsd)) - - return root - - def newXmlTree(self, root): - """ Return a XML file tree with the correct namespaces set, - the element root as top entry and the given header comment. - """ - t = libxml2.newNode(root) - return self.decorateWithHeader(t) - - @staticmethod - def validateXml(fpath, xmlschema_context): - retval = True - - # Create validation context - validation_context = xmlschema_context.schemaNewValidCtxt() - # Set error/warning handlers - eh = Libxml2ValidityHandler() - validation_context.setValidityErrorHandler(eh.error, eh.warning, ARG) - # Read file and resolve entities - doc = libxml2.readFile(fpath, None, libxml2.XML_PARSE_NOENT) - doc.xincludeProcessFlags(libxml2.XML_PARSE_NOENT) - err = validation_context.schemaValidateDoc(doc) - - if err or eh.errors: - for e in eh.errors: - print(e.rstrip("\n")) - # import pdb; pdb.set_trace() - print("%s fails to validate" % fpath) - retval = False - - # Cleanup - doc.freeDoc() - del validation_context - - return retval - - @staticmethod - def findAll(root, tag, ns=None, xpath_context=None, nsmap=None): - if hasattr(root, 'xpathEval') and xpath_context: - # Use the xpath context - xpath_context.setContextNode(root) - expression = ".//%s" % tag - if ns: - expression = ".//%s:%s" % (ns, tag) - return xpath_context.xpathEval(expression) - else: - expression = ".//{%s}%s" % (nsmap[ns], tag) - if not ns or not nsmap: - expression = ".//%s" % tag - return root.findall(expression) - - @staticmethod - def findAllChildrenOf(root, tag, ns=None, xpath_context=None, nsmap=None): - if hasattr(root, 'xpathEval') and xpath_context: - # Use the xpath context - xpath_context.setContextNode(root) - expression = "./%s/node()" % tag - if ns: - expression = "./%s:%s/node()" % (ns, tag) - - return xpath_context.xpathEval(expression) - else: - expression = "./{%s}%s/node()" % (nsmap[ns], tag) - if not ns or not nsmap: - expression = "./%s/node()" % tag - return root.findall(expression) - - def expandChildElements(self, child): - """ Helper function for convertElementTree, - converts a single child recursively. - """ - nchild = self.newNode(child.tag) - # Copy attributes - for key, val in child.attrib: - self.setAttribute(nchild, key, val) - elements = [] - # Add text - if child.text: - t = libxml2.newText(child.text) - self.appendNode(nchild, t) - # Add children - for c in child: - for n in self.expandChildElements(c): - self.appendNode(nchild, n) - elements.append(nchild) - # Add tail - if child.tail: - tail = libxml2.newText(child.tail) - elements.append(tail) - - return elements - - def convertElementTree(self, root): - """ Convert the given tree of etree.Element - entries to a list of tree nodes for the - current XML toolkit. - """ - nroot = self.newNode(root.tag) - # Copy attributes - for key, val in root.attrib: - self.setAttribute(nroot, key, val) - elements = [] - # Add text - if root.text: - t = libxml2.newText(root.text) - self.appendNode(nroot, t) - # Add children - for c in root: - for n in self.expandChildElements(c): - self.appendNode(nroot, n) - elements.append(nroot) - # Add tail - if root.tail: - tail = libxml2.newText(root.tail) - elements.append(tail) - - return elements + # singleton to cache parsed xmlschema.. + xmlschema = None + + @staticmethod + def validateXml(fpath, xmlschema_context): + + if TreeFactory.xmlschema is None: + TreeFactory.xmlschema = etree.XMLSchema(xmlschema_context) + try: + doc = etree.parse(fpath) + except Exception as e: + print("ERROR: %s fails to parse:"%fpath) + print(e) + return False + doc.xinclude() + try: + TreeFactory.xmlschema.assertValid(doc) + except Exception as e: + print("ERROR: %s fails to validate:" % fpath) + print(e) + return False + return True + + @staticmethod + def findAll(root, tag, ns=None, xp_ctxt=None, nsmap=None): + expression = ".//{%s}%s" % (nsmap[ns], tag) + if not ns or not nsmap: + expression = ".//%s" % tag + return root.findall(expression) + + @staticmethod + def findAllChildrenOf(root, tag, ns=None, xp_ctxt=None, nsmap=None): + expression = "./{%s}%s/*" % (nsmap[ns], tag) + if not ns or not nsmap: + expression = "./%s/*" % tag + return root.findall(expression) + + @staticmethod + def convertElementTree(root): + """ Convert the given tree of etree.Element + entries to a list of tree nodes for the + current XML toolkit. + """ + return [root] tf = TreeFactory() @@ -641,19 +402,9 @@ class SConsDocTree: self.root = etree.fromstring(content) def parseXmlFile(self, fpath): - if not has_libxml2: - # Create domtree from file - domtree = etree.parse(fpath) - self.root = domtree.getroot() - else: - # Read file and resolve entities - self.doc = libxml2.readFile(fpath, None, libxml2.XML_PARSE_NOENT) - self.root = self.doc.getRootElement() - # Create xpath context - self.xpath_context = self.doc.xpathNewContext() - # Register namespaces - for key, val in self.nsmap.items(): - self.xpath_context.xpathRegisterNs(key, val) + # Create domtree from file + domtree = etree.parse(fpath) + self.root = domtree.getroot() def __del__(self): if self.doc is not None: @@ -664,15 +415,7 @@ class SConsDocTree: perc = "%" def validate_all_xml(dpaths, xsdfile=default_xsd): - xmlschema_context = None - if not has_libxml2: - # Use lxml - xmlschema_context = etree.parse(xsdfile) - else: - # Use libxml2 and prepare the schema validation context - ctxt = libxml2.schemaNewParserCtxt(xsdfile) - xmlschema_context = ctxt.schemaParse() - del ctxt + xmlschema_context = etree.parse(xsdfile) fpaths = [] for dp in dpaths: @@ -698,10 +441,6 @@ def validate_all_xml(dpaths, xsdfile=default_xsd): fails.append(fp) continue - if has_libxml2: - # Cleanup - del xmlschema_context - if fails: return False diff --git a/bin/SConsExamples.py b/bin/SConsExamples.py index 46df103..bfc9002 100644 --- a/bin/SConsExamples.py +++ b/bin/SConsExamples.py @@ -85,6 +85,7 @@ # Error output gets passed through to your error output so you # can see if there are any problems executing the command. # +# TODO DB Check file encoding for unicode/utf-8 import os import re diff --git a/bin/docs-create-example-outputs.py b/bin/docs-create-example-outputs.py index 0124435..e74c547 100644 --- a/bin/docs-create-example-outputs.py +++ b/bin/docs-create-example-outputs.py @@ -3,6 +3,7 @@ # Searches through the whole doc/user tree and creates # all output files for the single examples. # +# TODO DB Check file encoding for unicode/utf-8 import os import sys import SConsExamples diff --git a/bin/docs-update-generated.py b/bin/docs-update-generated.py index 3687896..4226473 100644 --- a/bin/docs-update-generated.py +++ b/bin/docs-update-generated.py @@ -6,6 +6,7 @@ # as well as the entity declarations for them. # Uses scons-proc.py under the hood... # +# TODO DB Check file encoding for unicode/utf-8 import os import sys import subprocess diff --git a/bin/docs-validate.py b/bin/docs-validate.py index c4dd3b7..53b6f86 100644 --- a/bin/docs-validate.py +++ b/bin/docs-validate.py @@ -3,6 +3,7 @@ # Searches through the whole source tree and validates all # documentation files against our own XSD in docs/xsd. # +# TODO DB Check file encoding for unicode/utf-8 import sys,os import SConsDoc diff --git a/bin/scons-proc.py b/bin/scons-proc.py index 95a798c..e1a2d19 100644 --- a/bin/scons-proc.py +++ b/bin/scons-proc.py @@ -9,6 +9,7 @@ # DocBook-formatted generated XML files containing the summary text # and/or .mod files containing the ENTITY definitions for each item. # +# TODO DB Check file encoding for unicode/utf-8 import getopt import os import sys @@ -66,6 +67,7 @@ def parse_docs(args, include_entities=True): raise else: # mode we read (text/bytes) has to match handling in SConsDoc + # TODO DB Check file encoding for unicode/utf-8 with open(f, 'r') as fp: content = fp.read() if content: @@ -76,12 +78,14 @@ def parse_docs(args, include_entities=True): raise return h +# TODO DB Check file encoding for unicode/utf-8 Warning = """\ """ +# TODO DB Check file encoding for unicode/utf-8 Regular_Entities_Header = """\ """ -# TODO DB Check file encoding for unicode/utf-8 Regular_Entities_Header = """\ COMPILATIONDB_USE_ABSPATH diff --git a/SCons/Tool/docbook/__init__.xml b/SCons/Tool/docbook/__init__.xml index a774a2d..0835440 100644 --- a/SCons/Tool/docbook/__init__.xml +++ b/SCons/Tool/docbook/__init__.xml @@ -56,9 +56,6 @@ a PDF renderer, e.g. fop. So make sure that these are added t the Python lxml binding to libxml2, or -the direct Python bindings for libxml2/libxslt, or - - a standalone XSLT processor, currently detected are xsltproc, saxon, saxon-xslt and xalan. diff --git a/doc/generated/builders.gen b/doc/generated/builders.gen index 7a66bd4..77f9bfb 100644 --- a/doc/generated/builders.gen +++ b/doc/generated/builders.gen @@ -18,7 +18,7 @@ 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 &cv-link-CFILESUFFIX; construction variable (.c by default) is automatically added to the target if it is not already present. @@ -37,7 +37,7 @@ env.CFile(target = 'bar', source = 'bar.y') Command() env.Command() -The Command "Builder" is actually +The &b-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 @@ -45,7 +45,7 @@ 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 &f-link-Command; function description for the calling syntax and details. @@ -54,7 +54,7 @@ for the calling syntax and details. CompilationDatabase() env.CompilationDatabase() - The CompilationDatabase builder writes a JSON formatted compilation + The &b-CompilationDatabase; builder writes a JSON formatted compilation database according to the LLVM specification which is consumed by a number of clang tools, editors, and other tools. @@ -71,15 +71,15 @@ env.CompilationDatabase('my_output.json') If you specify more than one source, the source list will be ignored. - You should not specify source files. The CompilationDatabase builder instruments SCons to collect them from all + You should not specify source files. The &b-CompilationDatabase; builder instruments SCons to collect them from all the C, C++, assembly source/target pairs. - NOTE: You must load the compilation_db tool prior to specifying any part of your build or some source/target + NOTE: You must load the &t-compilation_db; tool prior to specifying any part of your build or some source/target files will not show up in your output file. - Available since scons 4.0. + Available since &scons; 4.0. @@ -90,7 +90,7 @@ env.CompilationDatabase('my_output.json') 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 &cv-link-CXXFILESUFFIX; construction variable (.cc by default) is automatically added to the target if it is not already present. @@ -343,31 +343,31 @@ 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 &cv-link-LATEXCOM; command line; +otherwise, the &cv-link-TEXCOM; command line is used. If the file is a LaTeX file, the -DVI +&b-DVI; builder method will also examine the contents of the .aux -file and invoke the $BIBTEX command line +file and invoke the &cv-link-BIBTEX; command line if the string bibdata is found, -start $MAKEINDEX to generate an index if a +start &cv-link-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 &cv-link-LATEXCOM; command if the log file says it is necessary. @@ -424,15 +424,15 @@ 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 +&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, +&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 +Use command line targets or the &Default; function in this case. @@ -445,7 +445,7 @@ 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). @@ -476,7 +476,7 @@ env.InstallAs(target=['../lib/libfoo.a', '../lib/libbar.a'], -See the note under Install. +See the note under &Install;. @@ -495,7 +495,7 @@ env.InstallVersionedLib(target='/usr/local/bin/foo', -See the note under Install. +See the note under &Install;. @@ -510,19 +510,19 @@ 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 &b-link-Java; Builder. -If the $JARCHDIR value is set, the -jar +If the &cv-link-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 &cv-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 &b-link-Java; Builder. @@ -530,7 +530,7 @@ 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. @@ -632,18 +632,18 @@ 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 &b-link-Java; builder method, or the objects returned from the -Java +&b-Java; builder method. If the construction variable -$JAVACLASSDIR +&cv-link-JAVACLASSDIR; is set, either in the environment or in the call to the -JavaH +&b-JavaH; builder method itself, then the value of the variable will be stripped from the @@ -676,7 +676,7 @@ env.JavaH( env.Library() A synonym for the -StaticLibrary +&b-StaticLibrary; builder method. @@ -687,7 +687,7 @@ builder method. On most systems, this is the same as -SharedLibrary. +&b-SharedLibrary;. On Mac OS X (Darwin) platforms, this creates a loadable module bundle. @@ -698,7 +698,7 @@ this creates a loadable module bundle. env.M4() Builds an output file from an M4 input file. -This uses a default $M4FLAGS value of +This uses a default &cv-link-M4FLAGS; value of , which considers all warnings to be fatal and stops on the first warning @@ -717,7 +717,7 @@ env.M4(target = 'foo.c', source = 'foo.c.m4') 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 &cv-link-QTDIR; variable for more information. Example: @@ -731,7 +731,7 @@ env.Moc('foo.cpp') # generates foo.moc MOFiles() env.MOFiles() -This builder belongs to msgfmt tool. The builder compiles +This builder belongs to &t-link-msgfmt; tool. The builder compiles PO files to MO files. @@ -788,7 +788,7 @@ Compile files for languages defined in LINGUAS file 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 + &cv-link-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 @@ -801,18 +801,18 @@ Compile files for languages defined in LINGUAS file 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 &b-MSVSProject;, in which case you presumably want to + build the solution file(s) by calling the &b-MSVSSolution; Builder (see below). - The MSVSProject builder takes several lists of filenames + The &b-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 + &cv-link-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. @@ -834,7 +834,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 &cv-link-MSVSPROJECTSUFFIX; construction variable will be defined to the correct value (see example below). @@ -852,7 +852,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 &b-MSVSProject; with different variants are allowed; all variants will be added to the project file with their appropriate build targets and sources. @@ -948,14 +948,14 @@ 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 &cv-link-CCFLAGS; variable so that the compiler will print the full path name of any files that cause compilation errors. @@ -1139,7 +1139,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], 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 + &cv-link-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. @@ -1152,7 +1152,7 @@ env.MSVSProject(target='Bar' + env['MSVSPROJECTSUFFIX'], 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 &cv-link-MSVSSOLUTIONSUFFIX; will be defined to the correct value (see example below). @@ -1171,7 +1171,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 &b-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. @@ -1197,7 +1197,7 @@ env.MSVSSolution( env.Object() A synonym for the -StaticObject +&b-StaticObject; builder method. @@ -1215,10 +1215,10 @@ 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 &b-Install; or &b-InstallAs; Builder attached. +If the ⌖ is not specified it will be deduced from additional information given to this Builder. @@ -1226,14 +1226,14 @@ 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 &cv-PACKAGETYPE; construction variable. Currently the following packagers available: @@ -1307,7 +1307,7 @@ from a .dvi input file .ltx, or .latex input file). -The suffix specified by the $PDFSUFFIX construction variable +The suffix specified by the &cv-link-PDFSUFFIX; construction variable (.pdf by default) is added automatically to the target if it is not already present. Example: @@ -1325,26 +1325,26 @@ 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 +This builder belongs to &t-link-msginit; tool. The builder initializes missing +PO file(s) if &cv-link-POAUTOINIT; is set. If +&cv-link-POAUTOINIT; is not set (default), &b-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 &b-POInit; and use &b-link-POUpdate; +instead. &b-link-POUpdate; chooses intelligently between +msgmerge(1) and msginit(1). &b-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 &b-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 &cv-link-POCREATE_ALIAS; construction variable. All PO files defined through -POInit may be easily initialized by scons po-create. +&b-POInit; may be easily initialized by scons po-create. @@ -1370,7 +1370,7 @@ Initialize en.po and pl.po from Example 3. Initialize en.po and pl.po from -foo.pot but using $POTDOMAIN construction +foo.pot but using &cv-link-POTDOMAIN; construction variable: @@ -1432,7 +1432,7 @@ from a .dvi input file .ltx, or .latex input file). -The suffix specified by the $PSSUFFIX construction variable +The suffix specified by the &cv-link-PSSUFFIX; construction variable (.ps by default) is added automatically to the target if it is not already present. Example: @@ -1450,14 +1450,14 @@ env.PostScript(target = 'bbb', source = 'bbb.dvi') POTUpdate() env.POTUpdate() -The builder belongs to xgettext tool. The builder updates target +The builder belongs to &t-link-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 +&cv-link-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). @@ -1465,7 +1465,7 @@ real change in internationalized messages (or in comments that enter You may see xgettext(1) being invoked by the -xgettext tool even if there is no real change in internationalized +&t-link-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 @@ -1499,10 +1499,10 @@ the results shall be as the comments above say. Example 2. -The POTUpdate builder may be used with no target specified, in which +The &b-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 &cv-link-POTDOMAIN; construction +variable or providing it as an override to &b-POTUpdate; builder: # SConstruct script @@ -1525,7 +1525,7 @@ The sources may be specified within separate file, for example The name of the file (POTFILES.in) containing the list of -sources is provided via $XGETTEXTFROM: +sources is provided via &cv-link-XGETTEXTFROM;: # SConstruct file in 'po/' subdirectory @@ -1535,7 +1535,7 @@ sources is provided via $XGETTEXTFROM Example 4. -You may use $XGETTEXTPATH to define source search path. Assume, for +You may use &cv-link-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 @@ -1615,21 +1615,21 @@ then the messages.pot will contain POUpdate() env.POUpdate() -The builder belongs to msgmerge tool. The builder updates +The builder belongs to &t-link-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 +&t-link-msginit; tool and &b-link-POInit; builder (see also +&cv-link-POAUTOINIT;). Note, that &b-POUpdate; does not add its +targets to po-create alias as &b-link-POInit; does. -Target nodes defined through POUpdate are not built by default +Target nodes defined through &b-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 &cv-link-POUPDATE_ALIAS; construction variable. You can easily update PO files in your project by scons po-update. @@ -1637,9 +1637,9 @@ po-update. Example 1. Update en.po and pl.po from -messages.pot template (see also $POTDOMAIN), +messages.pot template (see also &cv-link-POTDOMAIN;), assuming that the later one exists or there is rule to build it (see -POTUpdate): +&b-link-POTUpdate;): # ... @@ -1698,7 +1698,7 @@ from messages.pot template: Example 7. -Use $POAUTOINIT to automatically initialize PO file +Use &cv-link-POAUTOINIT; to automatically initialize PO file if it doesn't exist: @@ -1732,15 +1732,15 @@ 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 +&b-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 &cv-link-PROGPREFIX; construction variable; nothing by default) and suffix -(specified by the $PROGSUFFIX construction variable; +(specified by the &cv-link-PROGSUFFIX; construction variable; by default, .exe on Windows systems, nothing on POSIX systems) are automatically added to the target if not already present. @@ -1761,7 +1761,7 @@ env.Program(target = 'foo', source = ['foo.o', 'bar.c', 'baz.f']) 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 @@ -1811,16 +1811,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 +&b-Java; builder method. If the construction variable -$JAVACLASSDIR +&cv-link-JAVACLASSDIR; is set, either in the environment or in the call to the -RMIC +&b-RMIC; builder method itself, then the value of the variable will be stripped from the @@ -1928,11 +1928,11 @@ 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 &cv-link-SHLIBPREFIX; construction variable; by default, lib on POSIX systems, nothing on Windows systems) and suffix -(specified by the $SHLIBSUFFIX construction variable; +(specified by the &cv-link-SHLIBSUFFIX; construction variable; by default, .dll on Windows systems, .so on POSIX systems) are automatically added to the target if not already present. @@ -1945,7 +1945,7 @@ env.SharedLibrary(target = 'bar', source = ['bar.c', 'foo.o']) On Windows systems, the -SharedLibrary +&b-SharedLibrary; builder method will always build an import (.lib) library in addition to the shared (.dll) library, @@ -1956,7 +1956,7 @@ listed in the targets. On Cygwin systems, the -SharedLibrary +&b-SharedLibrary; builder method will always build an import (.dll.a) library in addition to the shared (.dll) library, @@ -1970,9 +1970,9 @@ Any object files listed in the source must have been built for a shared library (that is, using the -SharedObject +&b-SharedObject; builder method). -scons +&scons; will raise an error if there is any mismatch. @@ -1980,12 +1980,12 @@ 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 &b-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 &cv-link-SHLIBVERSION; construction variable is defined a versioned +shared library is created. This modifies the &cv-link-SHLINKFLAGS; as required, adds the version number to the library name, and creates the symlinks that are needed. @@ -2009,12 +2009,12 @@ On Windows systems, specifying 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 &cv-link-REGSVR; construction +variable, and the flags passed are determined by &cv-link-REGSVRFLAGS;. By +default, &cv-link-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. +&cv-link-REGSVRFLAGS;, be sure to include the option. For example, @@ -2038,7 +2038,7 @@ 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 +&b-StaticObject; builder method. On some platforms building a shared object requires additional compiler option @@ -2053,10 +2053,10 @@ 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 &cv-link-SHOBJPREFIX; construction variable; +by default, the same as &cv-link-OBJPREFIX;) and suffix -(specified by the $SHOBJSUFFIX construction variable) +(specified by the &cv-link-SHOBJSUFFIX; construction variable) are automatically added to the target if not already present. Examples: @@ -2089,11 +2089,11 @@ 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 &cv-link-LIBPREFIX; construction variable; by default, lib on POSIX systems, nothing on Windows systems) and suffix -(specified by the $LIBSUFFIX construction variable; +(specified by the &cv-link-LIBSUFFIX; construction variable; by default, .lib on Windows systems, .a on POSIX systems) are automatically added to the target if not already present. @@ -2109,9 +2109,9 @@ Any object files listed in the source must have been built for a static library (that is, using the -StaticObject +&b-StaticObject; builder method). -scons +&scons; will raise an error if there is any mismatch. @@ -2158,9 +2158,9 @@ Source files must have one of the following extensions: The target object file prefix -(specified by the $OBJPREFIX construction variable; nothing by default) +(specified by the &cv-link-OBJPREFIX; construction variable; nothing by default) and suffix -(specified by the $OBJSUFFIX construction variable; +(specified by the &cv-link-OBJSUFFIX; construction variable; .obj on Windows systems, .o on POSIX systems) are automatically added to the target if not already present. @@ -2187,10 +2187,10 @@ 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. +The &b-Substfile; builder creates a single text file from another file or set of +files by concatenating them with &cv-LINESEPARATOR; and replacing text +using the &cv-SUBST_DICT; construction variable. Nested lists of source files +are flattened. See also &b-Textfile;. @@ -2199,14 +2199,14 @@ 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 prefix and suffix specified by the &cv-SUBSTFILEPREFIX; +and &cv-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 &cv-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 @@ -2276,7 +2276,7 @@ Builds a tar archive of the specified files and/or directories. Unlike most builder methods, the -Tar +&b-Tar; builder method may be called multiple times for a given target; each additional call @@ -2286,7 +2286,7 @@ 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. @@ -2313,21 +2313,21 @@ env.Tar('foo') Textfile() env.Textfile() -The Textfile builder generates a single text file. +The &b-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. +&cv-LINESEPARATOR; is used to separate the strings. -If present, the $SUBST_DICT construction variable +If present, the &cv-SUBST_DICT; construction variable is used to modify the strings before they are written; -see the Substfile description for details. +see the &b-Substfile; description for details. -The prefix and suffix specified by the $TEXTFILEPREFIX -and $TEXTFILESUFFIX construction variables +The prefix and suffix specified by the &cv-TEXTFILEPREFIX; +and &cv-TEXTFILESUFFIX; construction variables (an empty string and .txt by default, respectively) are automatically added to the target if they are not already present. Examples: @@ -2379,20 +2379,20 @@ blob.txt Translate() env.Translate() -This pseudo-builder belongs to gettext toolset. The builder extracts +This pseudo-builder belongs to &t-link-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 &cv-link-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 &cv-link-LINGUAS_FILE; and &cv-link-POTDOMAIN; are taken into +acount too. All other construction variables used by &b-link-POTUpdate;, and +&b-link-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 &b-Translate; # SConscript in 'po/' directory @@ -2543,12 +2543,12 @@ 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 &b-Program;, +&b-Library; and &b-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 &cv-link-QTDIR; variable for more information. Example: @@ -2567,7 +2567,7 @@ Builds a zip archive of the specified files and/or directories. Unlike most builder methods, the -Zip +&b-Zip; builder method may be called multiple times for a given target; each additional call @@ -2577,7 +2577,7 @@ 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. diff --git a/doc/generated/examples/sideeffect_simple_1.xml b/doc/generated/examples/sideeffect_simple_1.xml index 5436160..cc94830 100644 --- a/doc/generated/examples/sideeffect_simple_1.xml +++ b/doc/generated/examples/sideeffect_simple_1.xml @@ -1,9 +1,4 @@ % scons -Q --jobs=2 - File "/home/my/project/SConstruct", line 4 - - 'echo >$TARGET data1; echo >log updated file1')) - - ^ - -SyntaxError: unmatched ')' +echo > file1 data1; echo >log updated file1 +Copy("file2", "log") diff --git a/doc/generated/functions.gen b/doc/generated/functions.gen index bfe63e8..9743daa 100644 --- a/doc/generated/functions.gen +++ b/doc/generated/functions.gen @@ -24,7 +24,7 @@ for a complete explanation of the arguments and behavior. -Note that the env.Action +Note that the &f-env-Action; form of the invocation will expand construction variables in any argument strings, including the @@ -33,8 +33,8 @@ argument, at the time it is called using the construction variables in the env construction environment through which -env.Action was called. -The Action global function +&f-env-Action; was called. +The &f-Action; global function form delays all variable expansion until the Action object is actually used. @@ -54,7 +54,7 @@ to the specified as the specified method name. When called using the -env.AddMethod form, +&f-env-AddMethod; form, adds the specified function to the construction environment @@ -114,7 +114,7 @@ for a thorough discussion of its option-processing capabities. In addition to the arguments and values supported by the optparse add_option -method, AddOption +method, &f-AddOption; allows setting the nargs keyword value to @@ -134,7 +134,7 @@ the command line, the value of the keyword argument is produced, as usual; if there is no default -keyword argument in the AddOption call, +keyword argument in the &f-AddOption; call, None is produced. @@ -153,18 +153,18 @@ Options added via AddOption do not support the automatic recognition of abbreviations. Instead, to allow specific abbreviations, -include them in the AddOption call. +include them in the &f-AddOption; call. Once a new command-line option has been added with -AddOption, +&f-AddOption;, the option value may be accessed using -GetOption +&f-link-GetOption; or -env.GetOption. -SetOption is not currently supported for -options added with AddOption. +&f-link-env-GetOption;. +&f-link-SetOption; is not currently supported for +options added with &f-AddOption;. The subsidiary SConscript files must use the -Import +&f-link-Import; function to import the variables. Examples: @@ -3438,17 +3438,17 @@ SConscript(dirs=['one', 'two', 'three'], exports='shared_info') If the optional variant_dir argument is present, it causes an effect equivalent to the -VariantDir function. +&f-link-VariantDir; function. The variant_dir argument is interpreted relative to the directory of the calling SConscript file. The optional duplicate argument is -interpreted as for VariantDir. +interpreted as for &f-link-VariantDir;. If variant_dir is omitted, the duplicate argument is ignored. See the description of -VariantDir +&f-link-VariantDir; below for additional details and restrictions. @@ -3480,7 +3480,7 @@ SConscript('build/SConscript') This later paradigm is often used when the sources are in the same directory as the -SConstruct: +&SConstruct;: @@ -3540,7 +3540,7 @@ 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 explicitly supplying -must_exist=False to the SConscript call. +must_exist=False to the &f-SConscript; call. @@ -3578,13 +3578,13 @@ SConscript('src/SConscript', variant_dir='build/ppc', duplicate=0) -SConscript returns the values of any variables +&f-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 +to the &f-link-Return; function (see above for details). +If a single &f-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 +script does not explicitly call &Return;, it returns None. @@ -3595,7 +3595,7 @@ script does not explicitly call Return, it returns env.SConscriptChdir(value) By default, -scons +&scons; changes its working directory to the directory in which each subsidiary SConscript file lives. @@ -3610,7 +3610,7 @@ 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, @@ -3640,7 +3640,7 @@ SConscript('bar/SConscript') # will chdir to bar env.SConsignFile([file, dbm_module]) This tells -scons +&scons; to store all file signatures in the specified database file. @@ -3657,7 +3657,7 @@ If file is not an absolute path name, the file is placed in the same directory as the top-level -SConstruct +&SConstruct; file. @@ -3667,7 +3667,7 @@ If is None, then -scons +&scons; will store file signatures in a separate .sconsign @@ -3822,7 +3822,7 @@ which corresponds to -Q. Note: The initial progress output will still be output as this is done before the SConstruct/SConscript which contains the SetOption is processed scons: Reading SConscript files ... -Available since scons 4.0. +Available since &scons; 4.0. @@ -3872,7 +3872,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 @@ -3904,9 +3904,9 @@ is cleaned whenever a specific is cleaned, you must specify this explicitly with the -Clean +&f-link-Clean; or -env.Clean +&f-env-Clean; function. @@ -3999,15 +3999,15 @@ keyword arguments must be set to lists of target and source nodes, respectively, if you want the -$TARGET, -$TARGETS, -$SOURCE +&cv-TARGET;, +&cv-TARGETS;, +&cv-SOURCE; and -$SOURCES +&cv-SOURCES; to be available for expansion. This is usually necessary if you are calling -env.subst +&f-env-subst; from within a Python function used as an SCons action. @@ -4025,7 +4025,7 @@ For example, if you want Python objects (including SCons Nodes) to be returned as Python objects, you can use the Python -Λ +λ idiom to pass in an unnamed function that simply returns its unconverted argument. @@ -4052,7 +4052,7 @@ source_nodes = env.subst('$EXPAND_TO_NODELIST', Annotates file or directory Nodes with information about how the -Package +&b-link-Package; Builder should package those files or directories. All tags are optional. @@ -4080,7 +4080,7 @@ Runs the tool identified by searched for in standard locations and any paths specified by the optional toolpath, -to update a construction environment with construction variables +to update a &consenv; with &consvars; needed to use the mechanisms that tool describes. Any additional keyword arguments kwargs are passed @@ -4088,11 +4088,11 @@ on to the tool module's generate function. -When called as a construction environment method, +When called as a &consenv; 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. +&consenv; and the name of the tool is +appended to the &cv-link-TOOLS; +&consvar; in that environment. @@ -4110,12 +4110,12 @@ 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 +&f-link-Environment; or &f-link-Clone; call as part of the tools keyword argument, or it can be called directly, -passing a construction environment to update as the argument. +passing a &consenv; to update as the argument. Either approach will also update the -$TOOLS construction variable. +&cv-TOOLS; &consvar;. @@ -4214,7 +4214,7 @@ env.UpdateValue(target = Value(output), source = Value(input)) env.VariantDir(variant_dir, src_dir, [duplicate]) Use the -VariantDir +&f-VariantDir; function to create a copy of your sources in another location: if a name under variant_dir @@ -4228,7 +4228,7 @@ within the variant tree. -VariantDir +&f-VariantDir; can be called multiple times with the same src_dir to set up multiple builds with different options @@ -4248,7 +4248,7 @@ 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 @@ -4277,7 +4277,7 @@ 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 @@ -4290,7 +4290,7 @@ and is usually safe for most builds Note that -VariantDir +&f-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 @@ -4298,7 +4298,7 @@ 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: @@ -4312,7 +4312,7 @@ SConscript('build/variant2/SConscript') See also the -SConscript +&f-link-SConscript; function, described above, for another way to specify a variant directory in conjunction with calling a subsidiary SConscript file. @@ -4351,11 +4351,11 @@ returning the full path to the program or None. -When called as a construction environment method, +When called as a &consenv; method, searches the paths in the path keyword argument, or if None (the default) -the paths listed in the construction environment +the paths listed in the &consenv; (env['ENV']['PATH']). The external environment's path list (os.environ['PATH']) @@ -4368,7 +4368,7 @@ 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 pathname extensions listed in the construction environment +the pathname extensions listed in the &consenv; (env['ENV']['PATHEXT']). The external environment's pathname extensions list (os.environ['PATHEXT']) diff --git a/doc/generated/tools.gen b/doc/generated/tools.gen index 4c1fb81..794b553 100644 --- a/doc/generated/tools.gen +++ b/doc/generated/tools.gen @@ -18,35 +18,35 @@ Sets construction variables for the 386ASM assembler for the Phar Lap ETS embedded operating system. -Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $CC $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS +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;. aixc++ Sets construction variables for the IMB xlc / Visual Age C++ compiler. -Sets: $CXX $CXXVERSION $SHCXX $SHOBJSUFFIX +Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;. aixcc Sets construction variables for the IBM xlc / Visual Age C compiler. -Sets: $CC $CCVERSION $SHCC +Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCC;. aixf77 Sets construction variables for the IBM Visual Age f77 Fortran compiler. -Sets: $F77 $SHF77 +Sets: &cv-link-F77;, &cv-link-SHF77;. aixlink Sets construction variables for the IBM Visual Age linker. -Sets: $LINKFLAGS $SHLIBSUFFIX $SHLINKFLAGS +Sets: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;. applelink @@ -54,87 +54,87 @@ Sets construction variables for the IBM Visual Age linker. Sets construction variables for the Apple linker (similar to the GNU linker). - 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 + 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;. ar -Sets construction variables for the ar library archiver. +Sets construction variables for the &ar; library archiver. -Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX $RANLIB $RANLIBCOM $RANLIBFLAGS +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;. as -Sets construction variables for the as assembler. +Sets construction variables for the &as; assembler. -Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $CC $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS +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;. bcc32 Sets construction variables for the bcc32 compiler. -Sets: $CC $CCCOM $CCFLAGS $CFILESUFFIX $CFLAGS $CPPDEFPREFIX $CPPDEFSUFFIX $INCPREFIX $INCSUFFIX $SHCC $SHCCCOM $SHCCFLAGS $SHCFLAGS $SHOBJSUFFIX Uses: $_CPPDEFFLAGS $_CPPINCFLAGS +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;. cc Sets construction variables for generic POSIX C compilers. -Sets: $CC $CCCOM $CCFLAGS $CFILESUFFIX $CFLAGS $CPPDEFPREFIX $CPPDEFSUFFIX $FRAMEWORKPATH $FRAMEWORKS $INCPREFIX $INCSUFFIX $SHCC $SHCCCOM $SHCCFLAGS $SHCFLAGS $SHOBJSUFFIX Uses: $CCCOMSTR $PLATFORM $SHCCCOMSTR +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-CCCOMSTR;, &cv-link-PLATFORM;, &cv-link-SHCCCOMSTR;. clang Set construction variables for the Clang C compiler. -Sets: $CC $CCVERSION $SHCCFLAGS +Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;. clangxx Set construction variables for the Clang C++ compiler. -Sets: $CXX $CXXVERSION $SHCXXFLAGS $SHOBJSUFFIX $STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME +Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJSUFFIX;, &cv-link-STATIC_AND_SHARED_OBJECTS_ARE_THE_SAME;. compilation_db - Sets up CompilationDatabase builder which generates a clang tooling compatible compilation database. + Sets up &b-link-CompilationDatabase; builder which generates a clang tooling compatible compilation database. - Sets: $COMPILATIONDB_COMSTR $COMPILATIONDB_USE_ABSPATH $__COMPILATIONDB_ENV $__COMPILATIONDB_UACTION $__COMPILATIONDB_USOURCE $__COMPILATIONDB_UTARGET + Sets: &cv-link-COMPILATIONDB_COMSTR;, &cv-link-COMPILATIONDB_USE_ABSPATH;. cvf Sets construction variables for the Compaq Visual Fortran compiler. -Sets: $FORTRAN $FORTRANCOM $FORTRANMODDIR $FORTRANMODDIRPREFIX $FORTRANMODDIRSUFFIX $FORTRANPPCOM $OBJSUFFIX $SHFORTRANCOM $SHFORTRANPPCOM Uses: $CPPFLAGS $FORTRANFLAGS $SHFORTRANFLAGS $_CPPDEFFLAGS $_FORTRANINCFLAGS $_FORTRANMODFLAG +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;. cXX Sets construction variables for generic POSIX C++ compilers. -Sets: $CPPDEFPREFIX $CPPDEFSUFFIX $CXX $CXXCOM $CXXFILESUFFIX $CXXFLAGS $INCPREFIX $INCSUFFIX $OBJSUFFIX $SHCXX $SHCXXCOM $SHCXXFLAGS $SHOBJSUFFIX Uses: $CXXCOMSTR $SHCXXCOMSTR +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;, &cv-link-SHCXXCOMSTR;. cyglink Set construction variables for cygwin linker/loader. -Sets: $IMPLIBPREFIX $IMPLIBSUFFIX $LDMODULEVERSIONFLAGS $LINKFLAGS $RPATHPREFIX $RPATHSUFFIX $SHLIBPREFIX $SHLIBSUFFIX $SHLIBVERSIONFLAGS $SHLINKCOM $SHLINKFLAGS $_LDMODULEVERSIONFLAGS $_SHLIBVERSIONFLAGS +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;. default -Sets construction variables for a default list of Tool modules. +Sets &consvars; 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 &consenv;, not an addition. @@ -144,8 +144,8 @@ 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 &consvar; +in the &consenv;. @@ -209,7 +209,7 @@ m4, rpm. Default lists for other platforms can be found by -examining the scons +examining the &scons; source code (see SCons/Tool/__init__.py). @@ -221,7 +221,7 @@ source code (see Sets construction variables for D language compiler DMD. -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 +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;. docbook @@ -256,9 +256,6 @@ a PDF renderer, e.g. fop. So make sure that these are added t the Python lxml binding to libxml2, or -the direct Python bindings for libxml2/libxslt, or - - a standalone XSLT processor, currently detected are xsltproc, saxon, saxon-xslt and xalan. @@ -296,15 +293,15 @@ Tool uses the given names as file stems, and adds the suffixes for target and so 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 &b-link-DocbookHtml;, +&b-link-DocbookPdf;, &b-link-DocbookEpub;, &b-link-DocbookSlidesPdf; and &b-link-DocbookXInclude;. For the +&b-link-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 &b-link-DocbookHtmlChunked;, &b-link-DocbookHtmlhelp; and +&b-link-DocbookSlidesHtml; are special, in that: they create a large set of files, where the exact names and their number depend on the content of the source file, and @@ -348,12 +345,12 @@ DOCBOOK_DEFAULT_XSL_SLIDESHTML DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') env.DocbookHtml('manual') # now uses html.xsl -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 +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;. dvi -Attaches the DVI builder to the +Attaches the &b-DVI; builder to the construction environment. @@ -363,69 +360,69 @@ construction environment. Sets construction variables for the dvipdf utility. -Sets: $DVIPDF $DVIPDFCOM $DVIPDFFLAGS Uses: $DVIPDFCOMSTR +Sets: &cv-link-DVIPDF;, &cv-link-DVIPDFCOM;, &cv-link-DVIPDFFLAGS;.Uses: &cv-link-DVIPDFCOMSTR;. dvips Sets construction variables for the dvips utility. -Sets: $DVIPS $DVIPSFLAGS $PSCOM $PSPREFIX $PSSUFFIX Uses: $PSCOMSTR +Sets: &cv-link-DVIPS;, &cv-link-DVIPSFLAGS;, &cv-link-PSCOM;, &cv-link-PSPREFIX;, &cv-link-PSSUFFIX;.Uses: &cv-link-PSCOMSTR;. f03 Set construction variables for generic POSIX Fortran 03 compilers. -Sets: $F03 $F03COM $F03FLAGS $F03PPCOM $SHF03 $SHF03COM $SHF03FLAGS $SHF03PPCOM $_F03INCFLAGS Uses: $F03COMSTR $F03PPCOMSTR $SHF03COMSTR $SHF03PPCOMSTR +Sets: &cv-link-F03;, &cv-link-F03COM;, &cv-link-F03FLAGS;, &cv-link-F03PPCOM;, &cv-link-SHF03;, &cv-link-SHF03COM;, &cv-link-SHF03FLAGS;, &cv-link-SHF03PPCOM;, &cv-link-_F03INCFLAGS;.Uses: &cv-link-F03COMSTR;, &cv-link-F03PPCOMSTR;, &cv-link-SHF03COMSTR;, &cv-link-SHF03PPCOMSTR;. f08 Set construction variables for generic POSIX Fortran 08 compilers. -Sets: $F08 $F08COM $F08FLAGS $F08PPCOM $SHF08 $SHF08COM $SHF08FLAGS $SHF08PPCOM $_F08INCFLAGS Uses: $F08COMSTR $F08PPCOMSTR $SHF08COMSTR $SHF08PPCOMSTR +Sets: &cv-link-F08;, &cv-link-F08COM;, &cv-link-F08FLAGS;, &cv-link-F08PPCOM;, &cv-link-SHF08;, &cv-link-SHF08COM;, &cv-link-SHF08FLAGS;, &cv-link-SHF08PPCOM;, &cv-link-_F08INCFLAGS;.Uses: &cv-link-F08COMSTR;, &cv-link-F08PPCOMSTR;, &cv-link-SHF08COMSTR;, &cv-link-SHF08PPCOMSTR;. f77 Set construction variables for generic POSIX Fortran 77 compilers. -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 +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;. f90 Set construction variables for generic POSIX Fortran 90 compilers. -Sets: $F90 $F90COM $F90FLAGS $F90PPCOM $SHF90 $SHF90COM $SHF90FLAGS $SHF90PPCOM $_F90INCFLAGS Uses: $F90COMSTR $F90PPCOMSTR $SHF90COMSTR $SHF90PPCOMSTR +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;. f95 Set construction variables for generic POSIX Fortran 95 compilers. -Sets: $F95 $F95COM $F95FLAGS $F95PPCOM $SHF95 $SHF95COM $SHF95FLAGS $SHF95PPCOM $_F95INCFLAGS Uses: $F95COMSTR $F95PPCOMSTR $SHF95COMSTR $SHF95PPCOMSTR +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;. fortran Set construction variables for generic POSIX Fortran compilers. -Sets: $FORTRAN $FORTRANCOM $FORTRANFLAGS $SHFORTRAN $SHFORTRANCOM $SHFORTRANFLAGS $SHFORTRANPPCOM Uses: $FORTRANCOMSTR $FORTRANPPCOMSTR $SHFORTRANCOMSTR $SHFORTRANPPCOMSTR +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;. g++ -Set construction variables for the gXX C++ compiler. +Set construction variables for the &gXX; C++ compiler. -Sets: $CXX $CXXVERSION $SHCXXFLAGS $SHOBJSUFFIX +Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;, &cv-link-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 &t-f77; Tool module to set variables. @@ -433,24 +430,24 @@ to set variables. gas -Sets construction variables for the gas assembler. -Calls the as module. +Sets construction variables for the &gas; assembler. +Calls the &t-as; module. -Sets: $AS +Sets: &cv-link-AS;. gcc -Set construction variables for the gcc C compiler. +Set construction variables for the &gcc; C compiler. -Sets: $CC $CCVERSION $SHCCFLAGS +Sets: &cv-link-CC;, &cv-link-CCVERSION;, &cv-link-SHCCFLAGS;. gdc Sets construction variables for the D language compiler GDC. -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 +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;. gettext @@ -463,25 +460,25 @@ following tools: - xgettext - to extract internationalized messages from source code to + &t-link-xgettext; - to extract internationalized messages from source code to POT file(s), - msginit - may be optionally used to initialize PO + &t-link-msginit; - may be optionally used to initialize PO files, - msgmerge - to update PO files, that already contain + &t-link-msgmerge; - to update PO files, that already contain translated messages, - msgfmt - to compile textual PO file to binary + &t-link-msgfmt; - to compile textual PO file to binary installable MO file. -When you enable gettext, it internally loads all abovementioned tools, +When you enable &t-gettext;, it internally loads all abovementioned tools, so you're encouraged to see their individual documentation. @@ -489,11 +486,11 @@ 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. +&b-Translate; described few paragraphs later. -To use gettext tools add 'gettext' tool to your +To use &t-gettext; tools add 'gettext' tool to your environment: @@ -506,26 +503,26 @@ environment: Sets construction variables for the GNU F95/F2003 GNU compiler. -Sets: $F77 $F90 $F95 $FORTRAN $SHF77 $SHF77FLAGS $SHF90 $SHF90FLAGS $SHF95 $SHF95FLAGS $SHFORTRAN $SHFORTRANFLAGS +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;. gnulink Set construction variables for GNU linker/loader. -Sets: $LDMODULEVERSIONFLAGS $RPATHPREFIX $RPATHSUFFIX $SHLIBVERSIONFLAGS $SHLINKFLAGS $_LDMODULESONAME $_SHLIBSONAME +Sets: &cv-link-LDMODULEVERSIONFLAGS;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLIBVERSIONFLAGS;, &cv-link-SHLINKFLAGS;, &cv-link-_LDMODULESONAME;, &cv-link-_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 (&b-link-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 (&b-link-Gs;) to the environment. -Sets: $GS $GSCOM $GSFLAGS Uses: $GSCOMSTR +Sets: &cv-link-GS;, &cv-link-GSCOM;, &cv-link-GSFLAGS;.Uses: &cv-link-GSCOMSTR;. hpc++ @@ -539,16 +536,16 @@ Set construction variables for the compilers aCC on HP/UX systems. Set construction variables for the aCC on HP/UX systems. -Calls the cXX tool for additional variables. +Calls the &t-cXX; tool for additional variables. -Sets: $CXX $CXXVERSION $SHCXXFLAGS +Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXXFLAGS;. hplink Sets construction variables for the linker on HP/UX systems. -Sets: $LINKFLAGS $SHLIBSUFFIX $SHLINKFLAGS +Sets: &cv-link-LINKFLAGS;, &cv-link-SHLIBSUFFIX;, &cv-link-SHLINKFLAGS;. icc @@ -556,13 +553,13 @@ Sets construction variables for the linker on HP/UX systems. Sets construction variables for the icc compiler on OS/2 systems. -Sets: $CC $CCCOM $CFILESUFFIX $CPPDEFPREFIX $CPPDEFSUFFIX $CXXCOM $CXXFILESUFFIX $INCPREFIX $INCSUFFIX Uses: $CCFLAGS $CFLAGS $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS +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;. icl Sets construction variables for the Intel C/C++ compiler. -Calls the intelc Tool module to set its variables. +Calls the &t-intelc; Tool module to set its variables. @@ -571,7 +568,7 @@ Calls the intelc Tool module to set its variables. Sets construction variables for the Intel Fortran compiler. -Sets: $FORTRAN $FORTRANCOM $FORTRANPPCOM $SHFORTRANCOM $SHFORTRANPPCOM Uses: $CPPFLAGS $FORTRANFLAGS $_CPPDEFFLAGS $_FORTRANINCFLAGS +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;. ifort @@ -579,7 +576,7 @@ Sets construction variables for the Intel Fortran compiler. Sets construction variables for newer versions of the Intel Fortran compiler for Linux. -Sets: $F77 $F90 $F95 $FORTRAN $SHF77 $SHF77FLAGS $SHF90 $SHF90FLAGS $SHF95 $SHF95FLAGS $SHFORTRAN $SHFORTRANFLAGS +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;. ilink @@ -587,7 +584,7 @@ of the Intel Fortran compiler for Linux. Sets construction variables for the ilink linker on OS/2 systems. -Sets: $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS +Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;. ilink32 @@ -595,7 +592,7 @@ Sets construction variables for the Sets construction variables for the Borland ilink32 linker. -Sets: $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS +Sets: &cv-link-LIBDIRPREFIX;, &cv-link-LIBDIRSUFFIX;, &cv-link-LIBLINKPREFIX;, &cv-link-LIBLINKSUFFIX;, &cv-link-LINK;, &cv-link-LINKCOM;, &cv-link-LINKFLAGS;. install @@ -603,60 +600,60 @@ Sets construction variables for the Borland Sets construction variables for file and directory installation. -Sets: $INSTALL $INSTALLSTR +Sets: &cv-link-INSTALL;, &cv-link-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 &t-gcc; or &t-msvc; (on Linux and Windows, respectively) to set underlying variables. -Sets: $AR $CC $CXX $INTEL_C_COMPILER_VERSION $LINK +Sets: &cv-link-AR;, &cv-link-CC;, &cv-link-CXX;, &cv-link-INTEL_C_COMPILER_VERSION;, &cv-link-LINK;. jar -Sets construction variables for the jar utility. +Sets construction variables for the &jar; utility. -Sets: $JAR $JARCOM $JARFLAGS $JARSUFFIX Uses: $JARCOMSTR +Sets: &cv-link-JAR;, &cv-link-JARCOM;, &cv-link-JARFLAGS;, &cv-link-JARSUFFIX;.Uses: &cv-link-JARCOMSTR;. javac - Sets construction variables for the javac compiler. + Sets construction variables for the &javac; compiler. - Sets: $JAVABOOTCLASSPATH $JAVAC $JAVACCOM $JAVACFLAGS $JAVACLASSPATH $JAVACLASSSUFFIX $JAVAINCLUDES $JAVASOURCEPATH $JAVASUFFIX Uses: $JAVACCOMSTR + 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;. javah -Sets construction variables for the javah tool. +Sets construction variables for the &javah; tool. -Sets: $JAVACLASSSUFFIX $JAVAH $JAVAHCOM $JAVAHFLAGS Uses: $JAVACLASSPATH $JAVAHCOMSTR +Sets: &cv-link-JAVACLASSSUFFIX;, &cv-link-JAVAH;, &cv-link-JAVAHCOM;, &cv-link-JAVAHFLAGS;.Uses: &cv-link-JAVACLASSPATH;, &cv-link-JAVAHCOMSTR;. latex -Sets construction variables for the latex utility. +Sets construction variables for the &latex; utility. -Sets: $LATEX $LATEXCOM $LATEXFLAGS Uses: $LATEXCOMSTR +Sets: &cv-link-LATEX;, &cv-link-LATEXCOM;, &cv-link-LATEXFLAGS;.Uses: &cv-link-LATEXCOMSTR;. ldc Sets construction variables for the D language compiler LDC2. -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 +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;. lex -Sets construction variables for the lex lexical analyser. +Sets construction variables for the &lex; lexical analyser. -Sets: $LEX $LEXCOM $LEXFLAGS $LEXUNISTD Uses: $LEXCOMSTR +Sets: &cv-link-LEX;, &cv-link-LEXCOM;, &cv-link-LEXFLAGS;, &cv-link-LEXUNISTD;.Uses: &cv-link-LEXCOMSTR;. link @@ -665,7 +662,7 @@ 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: $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 +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;. linkloc @@ -674,64 +671,64 @@ Sets construction variables for the LinkLoc linker for the Phar Lap ETS embedded operating system. -Sets: $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $LINKFLAGS $SHLINK $SHLINKCOM $SHLINKFLAGS Uses: $LINKCOMSTR $SHLINKCOMSTR +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;. m4 -Sets construction variables for the m4 macro processor. +Sets construction variables for the &m4; macro processor. -Sets: $M4 $M4COM $M4FLAGS Uses: $M4COMSTR +Sets: &cv-link-M4;, &cv-link-M4COM;, &cv-link-M4FLAGS;.Uses: &cv-link-M4COMSTR;. masm Sets construction variables for the Microsoft assembler. -Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $ASCOMSTR $ASPPCOMSTR $CPPFLAGS $_CPPDEFFLAGS $_CPPINCFLAGS +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;. midl Sets construction variables for the Microsoft IDL compiler. -Sets: $MIDL $MIDLCOM $MIDLFLAGS Uses: $MIDLCOMSTR +Sets: &cv-link-MIDL;, &cv-link-MIDLCOM;, &cv-link-MIDLFLAGS;.Uses: &cv-link-MIDLCOMSTR;. mingw Sets construction variables for MinGW (Minimal Gnu on Windows). -Sets: $AS $CC $CXX $LDMODULECOM $LIBPREFIX $LIBSUFFIX $OBJSUFFIX $RC $RCCOM $RCFLAGS $RCINCFLAGS $RCINCPREFIX $RCINCSUFFIX $SHCCFLAGS $SHCXXFLAGS $SHLINKCOM $SHLINKFLAGS $SHOBJSUFFIX $WINDOWSDEFPREFIX $WINDOWSDEFSUFFIX Uses: $RCCOMSTR $SHLINKCOMSTR +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;. msgfmt -This scons tool is a part of scons gettext toolset. It provides scons +This scons tool is a part of scons &t-link-gettext; toolset. It provides scons interface to msgfmt(1) command, which generates binary message catalog (MO) from a textual translation description (PO). -Sets: $MOSUFFIX $MSGFMT $MSGFMTCOM $MSGFMTCOMSTR $MSGFMTFLAGS $POSUFFIX Uses: $LINGUAS_FILE +Sets: &cv-link-MOSUFFIX;, &cv-link-MSGFMT;, &cv-link-MSGFMTCOM;, &cv-link-MSGFMTCOMSTR;, &cv-link-MSGFMTFLAGS;, &cv-link-POSUFFIX;.Uses: &cv-link-LINGUAS_FILE;. msginit -This scons tool is a part of scons gettext toolset. It provides +This scons tool is a part of scons &t-link-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: $MSGINIT $MSGINITCOM $MSGINITCOMSTR $MSGINITFLAGS $POAUTOINIT $POCREATE_ALIAS $POSUFFIX $POTSUFFIX $_MSGINITLOCALE Uses: $LINGUAS_FILE $POAUTOINIT $POTDOMAIN +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;. msgmerge -This scons tool is a part of scons gettext toolset. It provides +This scons tool is a part of scons &t-link-gettext; toolset. It provides scons interface to msgmerge(1) command, which merges two Uniform style .po files together. -Sets: $MSGMERGE $MSGMERGECOM $MSGMERGECOMSTR $MSGMERGEFLAGS $POSUFFIX $POTSUFFIX $POUPDATE_ALIAS Uses: $LINGUAS_FILE $POAUTOINIT $POTDOMAIN +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;. mslib @@ -740,14 +737,14 @@ Sets construction variables for the Microsoft mslib library archiver. -Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX Uses: $ARCOMSTR +Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.Uses: &cv-link-ARCOMSTR;. mslink Sets construction variables for the Microsoft linker. -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 +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;. mssdk @@ -756,40 +753,40 @@ 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: $MSSDK_DIR $MSSDK_VERSION $MSVS_VERSION +Uses: &cv-link-MSSDK_DIR;, &cv-link-MSSDK_VERSION;, &cv-link-MSVS_VERSION;. msvc Sets construction variables for the Microsoft Visual C/C++ compiler. -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 +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;. msvs Sets construction variables for Microsoft Visual Studio. - Sets: $MSVSBUILDCOM $MSVSCLEANCOM $MSVSENCODING $MSVSPROJECTCOM $MSVSREBUILDCOM $MSVSSCONS $MSVSSCONSCOM $MSVSSCONSCRIPT $MSVSSCONSFLAGS $MSVSSOLUTIONCOM + Sets: &cv-link-MSVSBUILDCOM;, &cv-link-MSVSCLEANCOM;, &cv-link-MSVSENCODING;, &cv-link-MSVSPROJECTCOM;, &cv-link-MSVSREBUILDCOM;, &cv-link-MSVSSCONS;, &cv-link-MSVSSCONSCOM;, &cv-link-MSVSSCONSCRIPT;, &cv-link-MSVSSCONSFLAGS;, &cv-link-MSVSSOLUTIONCOM;. mwcc Sets construction variables for the Metrowerks CodeWarrior compiler. -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 +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;. mwld Sets construction variables for the Metrowerks CodeWarrior linker. -Sets: $AR $ARCOM $LIBDIRPREFIX $LIBDIRSUFFIX $LIBLINKPREFIX $LIBLINKSUFFIX $LINK $LINKCOM $SHLINK $SHLINKCOM $SHLINKFLAGS +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;. nasm @@ -797,7 +794,7 @@ Sets construction variables for the Metrowerks CodeWarrior linker. Sets construction variables for the nasm Netwide Assembler. -Sets: $AS $ASCOM $ASFLAGS $ASPPCOM $ASPPFLAGS Uses: $ASCOMSTR $ASPPCOMSTR +Sets: &cv-link-AS;, &cv-link-ASCOM;, &cv-link-ASFLAGS;, &cv-link-ASPPCOM;, &cv-link-ASPPFLAGS;.Uses: &cv-link-ASCOMSTR;, &cv-link-ASPPCOMSTR;. packaging @@ -809,7 +806,7 @@ A framework for building binary and source packages. Packaging -Sets construction variables for the Package Builder. +Sets construction variables for the &b-Package; Builder. @@ -818,21 +815,21 @@ Sets construction variables for the Package Builder. Sets construction variables for the Portable Document Format builder. -Sets: $PDFPREFIX $PDFSUFFIX +Sets: &cv-link-PDFPREFIX;, &cv-link-PDFSUFFIX;. pdflatex -Sets construction variables for the pdflatex utility. +Sets construction variables for the &pdflatex; utility. -Sets: $LATEXRETRIES $PDFLATEX $PDFLATEXCOM $PDFLATEXFLAGS Uses: $PDFLATEXCOMSTR +Sets: &cv-link-LATEXRETRIES;, &cv-link-PDFLATEX;, &cv-link-PDFLATEXCOM;, &cv-link-PDFLATEXFLAGS;.Uses: &cv-link-PDFLATEXCOMSTR;. pdftex -Sets construction variables for the pdftex utility. +Sets construction variables for the &pdftex; utility. -Sets: $LATEXRETRIES $PDFLATEX $PDFLATEXCOM $PDFLATEXFLAGS $PDFTEX $PDFTEXCOM $PDFTEXFLAGS Uses: $PDFLATEXCOMSTR $PDFTEXCOMSTR +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;. python @@ -842,7 +839,7 @@ 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.. +Available since &scons; 4.0.. @@ -850,126 +847,126 @@ provided to an Action that uses this environment. Sets construction variables for building Qt applications. -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 +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;. rmic -Sets construction variables for the rmic utility. +Sets construction variables for the &rmic; utility. -Sets: $JAVACLASSSUFFIX $RMIC $RMICCOM $RMICFLAGS Uses: $RMICCOMSTR +Sets: &cv-link-JAVACLASSSUFFIX;, &cv-link-RMIC;, &cv-link-RMICCOM;, &cv-link-RMICFLAGS;.Uses: &cv-link-RMICCOMSTR;. rpcgen Sets construction variables for building with RPCGEN. -Sets: $RPCGEN $RPCGENCLIENTFLAGS $RPCGENFLAGS $RPCGENHEADERFLAGS $RPCGENSERVICEFLAGS $RPCGENXDRFLAGS +Sets: &cv-link-RPCGEN;, &cv-link-RPCGENCLIENTFLAGS;, &cv-link-RPCGENFLAGS;, &cv-link-RPCGENHEADERFLAGS;, &cv-link-RPCGENSERVICEFLAGS;, &cv-link-RPCGENXDRFLAGS;. sgiar Sets construction variables for the SGI library archiver. -Sets: $AR $ARCOMSTR $ARFLAGS $LIBPREFIX $LIBSUFFIX $SHLINK $SHLINKFLAGS Uses: $ARCOMSTR $SHLINKCOMSTR +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;. sgic++ Sets construction variables for the SGI C++ compiler. -Sets: $CXX $CXXFLAGS $SHCXX $SHOBJSUFFIX +Sets: &cv-link-CXX;, &cv-link-CXXFLAGS;, &cv-link-SHCXX;, &cv-link-SHOBJSUFFIX;. sgicc Sets construction variables for the SGI C compiler. -Sets: $CXX $SHOBJSUFFIX +Sets: &cv-link-CXX;, &cv-link-SHOBJSUFFIX;. sgilink Sets construction variables for the SGI linker. -Sets: $LINK $RPATHPREFIX $RPATHSUFFIX $SHLINKFLAGS +Sets: &cv-link-LINK;, &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;. sunar Sets construction variables for the Sun library archiver. -Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX Uses: $ARCOMSTR +Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.Uses: &cv-link-ARCOMSTR;. sunc++ Sets construction variables for the Sun C++ compiler. -Sets: $CXX $CXXVERSION $SHCXX $SHCXXFLAGS $SHOBJPREFIX $SHOBJSUFFIX +Sets: &cv-link-CXX;, &cv-link-CXXVERSION;, &cv-link-SHCXX;, &cv-link-SHCXXFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;. suncc Sets construction variables for the Sun C compiler. -Sets: $CXX $SHCCFLAGS $SHOBJPREFIX $SHOBJSUFFIX +Sets: &cv-link-CXX;, &cv-link-SHCCFLAGS;, &cv-link-SHOBJPREFIX;, &cv-link-SHOBJSUFFIX;. sunf77 -Set construction variables for the Sun f77 Fortran compiler. +Set construction variables for the Sun &f77; Fortran compiler. -Sets: $F77 $FORTRAN $SHF77 $SHF77FLAGS $SHFORTRAN $SHFORTRANFLAGS +Sets: &cv-link-F77;, &cv-link-FORTRAN;, &cv-link-SHF77;, &cv-link-SHF77FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. sunf90 -Set construction variables for the Sun f90 Fortran compiler. +Set construction variables for the Sun &f90; Fortran compiler. -Sets: $F90 $FORTRAN $SHF90 $SHF90FLAGS $SHFORTRAN $SHFORTRANFLAGS +Sets: &cv-link-F90;, &cv-link-FORTRAN;, &cv-link-SHF90;, &cv-link-SHF90FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. sunf95 -Set construction variables for the Sun f95 Fortran compiler. +Set construction variables for the Sun &f95; Fortran compiler. -Sets: $F95 $FORTRAN $SHF95 $SHF95FLAGS $SHFORTRAN $SHFORTRANFLAGS +Sets: &cv-link-F95;, &cv-link-FORTRAN;, &cv-link-SHF95;, &cv-link-SHF95FLAGS;, &cv-link-SHFORTRAN;, &cv-link-SHFORTRANFLAGS;. sunlink Sets construction variables for the Sun linker. -Sets: $RPATHPREFIX $RPATHSUFFIX $SHLINKFLAGS +Sets: &cv-link-RPATHPREFIX;, &cv-link-RPATHSUFFIX;, &cv-link-SHLINKFLAGS;. swig Sets construction variables for the SWIG interface generator. -Sets: $SWIG $SWIGCFILESUFFIX $SWIGCOM $SWIGCXXFILESUFFIX $SWIGDIRECTORSUFFIX $SWIGFLAGS $SWIGINCPREFIX $SWIGINCSUFFIX $SWIGPATH $SWIGVERSION $_SWIGINCFLAGS Uses: $SWIGCOMSTR +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;. tar -Sets construction variables for the tar archiver. +Sets construction variables for the &tar; archiver. -Sets: $TAR $TARCOM $TARFLAGS $TARSUFFIX Uses: $TARCOMSTR +Sets: &cv-link-TAR;, &cv-link-TARCOM;, &cv-link-TARFLAGS;, &cv-link-TARSUFFIX;.Uses: &cv-link-TARCOMSTR;. tex Sets construction variables for the TeX formatter and typesetter. -Sets: $BIBTEX $BIBTEXCOM $BIBTEXFLAGS $LATEX $LATEXCOM $LATEXFLAGS $MAKEINDEX $MAKEINDEXCOM $MAKEINDEXFLAGS $TEX $TEXCOM $TEXFLAGS Uses: $BIBTEXCOMSTR $LATEXCOMSTR $MAKEINDEXCOMSTR $TEXCOMSTR +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;. textfile -Set construction variables for the Textfile and Substfile builders. +Set construction variables for the &b-Textfile; and &b-Substfile; builders. -Sets: $LINESEPARATOR $SUBSTFILEPREFIX $SUBSTFILESUFFIX $TEXTFILEPREFIX $TEXTFILESUFFIX Uses: $SUBST_DICT +Sets: &cv-link-LINESEPARATOR;, &cv-link-SUBSTFILEPREFIX;, &cv-link-SUBSTFILESUFFIX;, &cv-link-TEXTFILEPREFIX;, &cv-link-TEXTFILESUFFIX;.Uses: &cv-link-SUBST_DICT;. tlib @@ -977,31 +974,31 @@ Set construction variables for the Textfile and S Sets construction variables for the Borlan tib library archiver. -Sets: $AR $ARCOM $ARFLAGS $LIBPREFIX $LIBSUFFIX Uses: $ARCOMSTR +Sets: &cv-link-AR;, &cv-link-ARCOM;, &cv-link-ARFLAGS;, &cv-link-LIBPREFIX;, &cv-link-LIBSUFFIX;.Uses: &cv-link-ARCOMSTR;. xgettext -This scons tool is a part of scons gettext toolset. It provides +This scons tool is a part of scons &t-link-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 &b-POTUpdate; builder to make PO Template files. -Sets: $POTSUFFIX $POTUPDATE_ALIAS $XGETTEXTCOM $XGETTEXTCOMSTR $XGETTEXTFLAGS $XGETTEXTFROM $XGETTEXTFROMPREFIX $XGETTEXTFROMSUFFIX $XGETTEXTPATH $XGETTEXTPATHPREFIX $XGETTEXTPATHSUFFIX $_XGETTEXTDOMAIN $_XGETTEXTFROMFLAGS $_XGETTEXTPATHFLAGS Uses: $POTDOMAIN +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;. yacc -Sets construction variables for the yacc parse generator. +Sets construction variables for the &yacc; parse generator. -Sets: $YACC $YACCCOM $YACCFLAGS $YACCHFILESUFFIX $YACCHXXFILESUFFIX $YACCVCGFILESUFFIX Uses: $YACCCOMSTR +Sets: &cv-link-YACC;, &cv-link-YACCCOM;, &cv-link-YACCFLAGS;, &cv-link-YACCHFILESUFFIX;, &cv-link-YACCHXXFILESUFFIX;, &cv-link-YACCVCGFILESUFFIX;.Uses: &cv-link-YACCCOMSTR;. zip -Sets construction variables for the zip archiver. +Sets construction variables for the &zip; archiver. -Sets: $ZIP $ZIPCOM $ZIPCOMPRESSION $ZIPFLAGS $ZIPSUFFIX Uses: $ZIPCOMSTR +Sets: &cv-link-ZIP;, &cv-link-ZIPCOM;, &cv-link-ZIPCOMPRESSION;, &cv-link-ZIPFLAGS;, &cv-link-ZIPSUFFIX;.Uses: &cv-link-ZIPCOMSTR;. diff --git a/doc/generated/variables.gen b/doc/generated/variables.gen index 3795aab..6f23d98 100644 --- a/doc/generated/variables.gen +++ b/doc/generated/variables.gen @@ -17,8 +17,8 @@ __LDMODULEVERSIONFLAGS -This construction variable automatically introduces $_LDMODULEVERSIONFLAGS -if $LDMODULEVERSION is set. Othervise it evaluates to an empty string. +This construction variable automatically introduces &cv-link-_LDMODULEVERSIONFLAGS; +if &cv-link-LDMODULEVERSION; is set. Othervise it evaluates to an empty string. @@ -27,8 +27,8 @@ if $LDMODULEVERSION is __SHLIBVERSIONFLAGS -This construction variable automatically introduces $_SHLIBVERSIONFLAGS -if $SHLIBVERSION is set. Othervise it evaluates to an empty string. +This construction variable automatically introduces &cv-link-_SHLIBVERSIONFLAGS; +if &cv-link-SHLIBVERSION; is set. Othervise it evaluates to an empty string. @@ -43,12 +43,12 @@ if $SHLIBVERSION is set. O 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 &cv-link-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 &cv-link-APPLELINK_NO_COMPATIBILITY_VERSION; is set then no -compatibility_version will be output. See MacOS's ld manpage for more details @@ -61,8 +61,8 @@ if $SHLIBVERSION is set. O 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 + The default generator uses &cv-link-APPLELINK_COMPATIBILITY_VERSION; + and &cv-link-APPLELINK_NO_COMPATIBILITY_VERSION; and &cv-link-SHLIBVERSION; to determine the correct flag. @@ -78,11 +78,11 @@ if $SHLIBVERSION is set. O 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 &cv-link-SHLIBVERSION; if not specified. - If the $APPLELINK_NO_CURRENT_VERSION is set then no -current_version will be + If the &cv-link-APPLELINK_NO_CURRENT_VERSION; is set then no -current_version will be output. See MacOS's ld manpage for more details @@ -95,8 +95,8 @@ if $SHLIBVERSION is set. O 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. + -current_version flag. The default generator uses &cv-link-APPLELINK_CURRENT_VERSION; and + &cv-link-APPLELINK_NO_CURRENT_VERSION; and &cv-link-SHLIBVERSION; to determine the correct flag. @@ -109,7 +109,7 @@ if $SHLIBVERSION is set. O generating versioned shared libraries. - This overrides $APPLELINK_COMPATIBILITY_VERSION. + This overrides &cv-link-APPLELINK_COMPATIBILITY_VERSION;. @@ -122,7 +122,7 @@ if $SHLIBVERSION is set. O generating versioned shared libraries. - This overrides $APPLELINK_CURRENT_VERSION. + This overrides &cv-link-APPLELINK_CURRENT_VERSION;. @@ -170,7 +170,7 @@ The command line used to generate a static library from object files. The string displayed when a static library is generated from object files. -If this is not set, then $ARCOM (the command line) is displayed. +If this is not set, then &cv-link-ARCOM; (the command line) is displayed. @@ -213,7 +213,7 @@ from an assembly-language source file. 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 &cv-link-ASCOM; (the command line) is displayed. @@ -239,7 +239,7 @@ 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 &cv-link-ASFLAGS; and &cv-link-CPPFLAGS; construction variables are included on this command line. @@ -252,7 +252,7 @@ are included on this command line. 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 &cv-link-ASPPCOM; (the command line) is displayed. @@ -268,7 +268,7 @@ env = Environment(ASPPCOMSTR = "Assembling $TARGET") 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 &cv-link-ASFLAGS;. @@ -300,7 +300,7 @@ typesetter. 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 &cv-link-BIBTEXCOM; (the command line) is displayed. @@ -373,9 +373,9 @@ The C compiler. 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. -See also $SHCCCOM for compiling to shared objects. +file. Any options specified in the &cv-link-CFLAGS;, &cv-link-CCFLAGS; and +&cv-link-CPPFLAGS; construction variables are included on this command line. +See also &cv-link-SHCCCOM; for compiling to shared objects. @@ -386,8 +386,8 @@ See also $SHCCCOM for compiling If set, the string displayed when a C source file is compiled to a (static) object file. -If not set, then $CCCOM (the command line) is displayed. -See also $SHCCCOMSTR for compiling to shared objects. +If not set, then &cv-link-CCCOM; (the command line) is displayed. +See also &cv-link-SHCCCOMSTR; for compiling to shared objects. @@ -401,7 +401,7 @@ env = Environment(CCCOMSTR = "Compiling static object $TARGET") General options that are passed to the C and C++ compilers. -See also $SHCCFLAGS for compiling to shared objects. +See also &cv-link-SHCCFLAGS; for compiling to shared objects. @@ -414,7 +414,7 @@ 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 &cv-link-PCH; construction variable is set. @@ -428,7 +428,7 @@ 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 &cv-link-PDB; construction variable is set. @@ -446,7 +446,7 @@ 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 &cv-link-CCPDBFLAGS; variable as follows: @@ -457,7 +457,7 @@ 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 &cv-link-CCPDBFLAGS; variable as follows: @@ -501,7 +501,7 @@ as C files. General options that are passed to the C compiler (C only; not C++). -See also $SHCFLAGS for compiling to shared objects. +See also &cv-link-SHCFLAGS; for compiling to shared objects. @@ -571,7 +571,7 @@ section of the RPM COMPILATIONDB_USE_ABSPATH - This is a boolean flag to instruct CompilationDatabase to + This is a boolean flag to instruct &b-link-CompilationDatabase; to write the file and target members in the compilation database with absolute or relative paths. @@ -585,7 +585,7 @@ section of the RPM _concat -A function used to produce variables like $_CPPINCFLAGS. It takes +A function used to produce variables like &cv-_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 @@ -637,11 +637,11 @@ file. An automatically-generated construction variable containing the C preprocessor command-line options to define values. -The value of $_CPPDEFFLAGS is created +The value of &cv-_CPPDEFFLAGS; is created by respectively prepending and appending -$CPPDEFPREFIX and $CPPDEFSUFFIX +&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; to the beginning and end -of each definition in $CPPDEFINES. +of each definition in &cv-CPPDEFINES;. @@ -653,18 +653,18 @@ of each definition in $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), +&cv-_CPPDEFFLAGS; construction variable (see above), which is constructed according to -the type of value of $CPPDEFINES: +the type of value of &cv-CPPDEFINES;: -If $CPPDEFINES is a string, +If &cv-CPPDEFINES; is a string, the values of the -$CPPDEFPREFIX and $CPPDEFSUFFIX +&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; construction variables will be respectively prepended and appended to the beginning and end -of each definition in $CPPDEFINES. +of each definition in &cv-CPPDEFINES;. @@ -674,9 +674,9 @@ env = Environment(CPPDEFINES='xyz') -If $CPPDEFINES is a list, +If &cv-CPPDEFINES; is a list, the values of the -$CPPDEFPREFIX and $CPPDEFSUFFIX +&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; construction variables will be respectively prepended and appended to the beginning and end of each element in the list. @@ -692,9 +692,9 @@ env = Environment(CPPDEFINES=[('B', 2), 'A']) -If $CPPDEFINES is a dictionary, +If &cv-CPPDEFINES; is a dictionary, the values of the -$CPPDEFPREFIX and $CPPDEFSUFFIX +&cv-CPPDEFPREFIX; and &cv-CPPDEFSUFFIX; construction variables will be respectively prepended and appended to the beginning and end of each item from the dictionary. @@ -707,7 +707,7 @@ 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. @@ -726,8 +726,8 @@ env = Environment(CPPDEFINES={'B':2, 'A':None}) 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 &cv-CPPDEFINES; construction variable +when the &cv-_CPPDEFFLAGS; variable is automatically generated. @@ -739,8 +739,8 @@ when the $_CPPDEFFLAGS variable is automatically generated. 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 &cv-CPPDEFINES; construction variable +when the &cv-_CPPDEFFLAGS; variable is automatically generated. @@ -752,16 +752,16 @@ when the $_CPPDEFFLAGS variable is automatically generated. 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 &cv-link-CCCOM;, +&cv-link-SHCCCOM;, +&cv-link-CXXCOM; and +&cv-link-SHCXXCOM; command lines, +but also the &cv-link-FORTRANPPCOM;, +&cv-link-SHFORTRANPPCOM;, +&cv-link-F77PPCOM; and +&cv-link-SHF77PPCOM; command lines used to compile a Fortran source file, -and the $ASPPCOM command line +and the &cv-link-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 @@ -769,8 +769,8 @@ 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 &cv-link-CPPPATH;. +See &cv-link-_CPPINCFLAGS;, below, for the variable that expands to those options. @@ -783,10 +783,10 @@ for the variable that expands to those options. 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 &cv-_CPPINCFLAGS; is created +by respectively prepending and appending &cv-INCPREFIX; and &cv-INCSUFFIX; to the beginning and end -of each directory in $CPPPATH. +of each directory in &cv-CPPPATH;. @@ -802,7 +802,7 @@ 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 #: @@ -812,7 +812,7 @@ env = Environment(CPPPATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -824,17 +824,17 @@ env = Environment(CPPPATH=include) The directory list will be added to command lines through the automatically-generated -$_CPPINCFLAGS +&cv-_CPPINCFLAGS; construction variable, which is constructed by respectively prepending and appending the value of the -$INCPREFIX and $INCSUFFIX +&cv-INCPREFIX; and &cv-INCSUFFIX; construction variables to the beginning and end -of each directory in $CPPPATH. +of each directory in &cv-CPPPATH;. Any command lines you define that need the CPPPATH directory list should -include $_CPPINCFLAGS: +include &cv-_CPPINCFLAGS;: @@ -868,7 +868,7 @@ The default list is: The C++ compiler. -See also $SHCXX for compiling to shared objects.. +See also &cv-link-SHCXX; for compiling to shared objects.. @@ -878,10 +878,10 @@ See also $SHCXX for compiling to 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 &cv-link-CXXFLAGS; and +&cv-link-CPPFLAGS; construction variables are included on this command line. -See also $SHCXXCOM for compiling to shared objects.. +See also &cv-link-SHCXXCOM; for compiling to shared objects.. @@ -892,8 +892,8 @@ See also $SHCXXCOM for compili If set, the string displayed when a C++ source file is compiled to a (static) object file. -If not set, then $CXXCOM (the command line) is displayed. -See also $SHCXXCOMSTR for compiling to shared objects.. +If not set, then &cv-link-CXXCOM; (the command line) is displayed. +See also &cv-link-SHCXXCOMSTR; for compiling to shared objects.. @@ -935,11 +935,11 @@ as C++ files. 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 &cv-link-CCFLAGS;, +so that setting &cv-CCFLAGS; affects both C and C++ compilation. If you want to add C++-specific flags, -you must set or override the value of $CXXFLAGS. -See also $SHCXXFLAGS for compiling to shared objects.. +you must set or override the value of &cv-link-CXXFLAGS;. +See also &cv-link-SHCXXFLAGS; for compiling to shared objects.. @@ -960,7 +960,7 @@ depending on the specific C++ compiler being used. The D compiler to use. -See also $SHDC for compiling to shared objects. +See also &cv-link-SHDC; for compiling to shared objects. @@ -970,9 +970,9 @@ See also $SHDC for compiling to sh 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 &cv-link-DFLAGS; construction variable is included on this command line. -See also $SHDCOM for compiling to shared objects. +See also &cv-link-SHDCOM; for compiling to shared objects. @@ -983,8 +983,8 @@ See also $SHDCOM for compiling t 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. +If not set, then &cv-link-DCOM; (the command line) is displayed. +See also &cv-link-SHDCOMSTR; for compiling to shared objects. @@ -1192,7 +1192,7 @@ DLIBLINKSUFFIX. Name of the linker to use for linking systems including D sources. -See also $SHDLINK for linking shared objects. +See also &cv-link-SHDLINK; for linking shared objects. @@ -1202,7 +1202,7 @@ See also $SHDLINK for linking s The command line to use when linking systems including D sources. -See also $SHDLINKCOM for linking shared objects. +See also &cv-link-SHDLINKCOM; for linking shared objects. @@ -1221,7 +1221,7 @@ DLINKFLAGPREFIX. List of linker flags. -See also $SHDLINKFLAGS for linking shared objects. +See also &cv-link-SHDLINKFLAGS; for linking shared objects. @@ -1239,7 +1239,7 @@ DLINKFLAGSUFFIX. DOCBOOK_DEFAULT_XSL_EPUB -The default XSLT file for the DocbookEpub builder within the +The default XSLT file for the &b-link-DocbookEpub; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1249,7 +1249,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_HTML -The default XSLT file for the DocbookHtml builder within the +The default XSLT file for the &b-link-DocbookHtml; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1259,7 +1259,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_HTMLCHUNKED -The default XSLT file for the DocbookHtmlChunked builder within the +The default XSLT file for the &b-link-DocbookHtmlChunked; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1269,7 +1269,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_HTMLHELP -The default XSLT file for the DocbookHtmlhelp builder within the +The default XSLT file for the &b-link-DocbookHtmlhelp; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1279,7 +1279,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_MAN -The default XSLT file for the DocbookMan builder within the +The default XSLT file for the &b-link-DocbookMan; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1289,7 +1289,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_PDF -The default XSLT file for the DocbookPdf builder within the +The default XSLT file for the &b-link-DocbookPdf; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1299,7 +1299,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_SLIDESHTML -The default XSLT file for the DocbookSlidesHtml builder within the +The default XSLT file for the &b-link-DocbookSlidesHtml; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1309,7 +1309,7 @@ current environment, if no other XSLT gets specified via keyword. DOCBOOK_DEFAULT_XSL_SLIDESPDF -The default XSLT file for the DocbookSlidesPdf builder within the +The default XSLT file for the &b-link-DocbookSlidesPdf; builder within the current environment, if no other XSLT gets specified via keyword. @@ -1551,7 +1551,7 @@ The command line used to convert TeX DVI files into a PDF file. 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 &cv-link-DVIPDFCOM; (the command line) is displayed. @@ -1589,21 +1589,21 @@ General options passed to the TeX DVI file to PostScript converter. A dictionary of environment variables to use when invoking commands. When -$ENV is used in a command all list +&cv-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. @@ -1628,7 +1628,7 @@ the system PATH environment variable, so that -scons +&scons; uses the same utilities as the invoking shell (or other process): @@ -1656,10 +1656,10 @@ string to escape; and should return the escaped command line. The Fortran 03 compiler. -You should normally set the $FORTRAN variable, +You should normally set the &cv-link-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 &cv-link-F03; if you need to use a specific compiler or compiler version for Fortran 03 files. @@ -1670,9 +1670,9 @@ or compiler version for Fortran 03 files. 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 &cv-link-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 &cv-link-FORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -1685,7 +1685,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 03 source file is compiled to an object file. -If not set, then $F03COM or $FORTRANCOM +If not set, then &cv-link-F03COM; or &cv-link-FORTRANCOM; (the command line) is displayed. @@ -1711,14 +1711,14 @@ Note that this variable does contain (or similar) include search path options -that scons generates automatically from $F03PATH. +that scons generates automatically from &cv-link-F03PATH;. See -$_F03INCFLAGS +&cv-link-_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 &cv-link-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 &cv-link-FORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1733,10 +1733,10 @@ for all Fortran versions. 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 &cv-link-_F03INCFLAGS; is created +by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end -of each directory in $F03PATH. +of each directory in &cv-link-F03PATH;. @@ -1748,15 +1748,15 @@ of each directory in $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 &cv-link-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 &cv-link-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 &cv-link-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 &cv-link-FORTRANPATH; variable, which specifies the include path for the default Fortran compiler for all Fortran versions. @@ -1768,7 +1768,7 @@ env = Environment(F03PATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -1780,17 +1780,17 @@ env = Environment(F03PATH=include) The directory list will be added to command lines through the automatically-generated -$_F03INCFLAGS +&cv-link-_F03INCFLAGS; construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; construction variables to the beginning and end -of each directory in $F03PATH. +of each directory in &cv-link-F03PATH;. Any command lines you define that need the F03PATH directory list should -include $_F03INCFLAGS: +include &cv-link-_F03INCFLAGS;: @@ -1805,11 +1805,11 @@ env = Environment(F03COM="my_compiler $_F03INCFLAGS -c -o $TARGET $SOURCE") 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 &cv-link-F03FLAGS; and &cv-link-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 &cv-link-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 &cv-link-FORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -1823,7 +1823,7 @@ for all Fortran versions. 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 not set, then $F03PPCOM or $FORTRANPPCOM +If not set, then &cv-link-F03PPCOM; or &cv-link-FORTRANPPCOM; (the command line) is displayed. @@ -1844,10 +1844,10 @@ F03 dialect will be used. By default, this is empty The Fortran 08 compiler. -You should normally set the $FORTRAN variable, +You should normally set the &cv-link-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 &cv-link-F08; if you need to use a specific compiler or compiler version for Fortran 08 files. @@ -1858,9 +1858,9 @@ or compiler version for Fortran 08 files. 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 &cv-link-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 &cv-link-FORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -1873,7 +1873,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 08 source file is compiled to an object file. -If not set, then $F08COM or $FORTRANCOM +If not set, then &cv-link-F08COM; or &cv-link-FORTRANCOM; (the command line) is displayed. @@ -1899,14 +1899,14 @@ Note that this variable does contain (or similar) include search path options -that scons generates automatically from $F08PATH. +that scons generates automatically from &cv-link-F08PATH;. See -$_F08INCFLAGS +&cv-link-_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 &cv-link-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 &cv-link-FORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -1921,10 +1921,10 @@ for all Fortran versions. 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 &cv-link-_F08INCFLAGS; is created +by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end -of each directory in $F08PATH. +of each directory in &cv-link-F08PATH;. @@ -1936,15 +1936,15 @@ of each directory in $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 &cv-link-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 &cv-link-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 &cv-link-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 &cv-link-FORTRANPATH; variable, which specifies the include path for the default Fortran compiler for all Fortran versions. @@ -1956,7 +1956,7 @@ env = Environment(F08PATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -1968,17 +1968,17 @@ env = Environment(F08PATH=include) The directory list will be added to command lines through the automatically-generated -$_F08INCFLAGS +&cv-link-_F08INCFLAGS; construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; construction variables to the beginning and end -of each directory in $F08PATH. +of each directory in &cv-link-F08PATH;. Any command lines you define that need the F08PATH directory list should -include $_F08INCFLAGS: +include &cv-link-_F08INCFLAGS;: @@ -1993,11 +1993,11 @@ env = Environment(F08COM="my_compiler $_F08INCFLAGS -c -o $TARGET $SOURCE") 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 &cv-link-F08FLAGS; and &cv-link-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 &cv-link-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 &cv-link-FORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -2011,7 +2011,7 @@ for all Fortran versions. 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 not set, then $F08PPCOM or $FORTRANPPCOM +If not set, then &cv-link-F08PPCOM; or &cv-link-FORTRANPPCOM; (the command line) is displayed. @@ -2032,10 +2032,10 @@ F08 dialect will be used. By default, this is empty The Fortran 77 compiler. -You should normally set the $FORTRAN variable, +You should normally set the &cv-link-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 &cv-link-F77; if you need to use a specific compiler or compiler version for Fortran 77 files. @@ -2046,9 +2046,9 @@ or compiler version for Fortran 77 files. 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 &cv-link-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 &cv-link-FORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -2061,7 +2061,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 77 source file is compiled to an object file. -If not set, then $F77COM or $FORTRANCOM +If not set, then &cv-link-F77COM; or &cv-link-FORTRANCOM; (the command line) is displayed. @@ -2087,14 +2087,14 @@ Note that this variable does contain (or similar) include search path options -that scons generates automatically from $F77PATH. +that scons generates automatically from &cv-link-F77PATH;. See -$_F77INCFLAGS +&cv-link-_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 &cv-link-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 &cv-link-FORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2109,10 +2109,10 @@ for all Fortran versions. 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 &cv-link-_F77INCFLAGS; is created +by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end -of each directory in $F77PATH. +of each directory in &cv-link-F77PATH;. @@ -2124,15 +2124,15 @@ of each directory in $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 &cv-link-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 &cv-link-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 &cv-link-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 &cv-link-FORTRANPATH; variable, which specifies the include path for the default Fortran compiler for all Fortran versions. @@ -2144,7 +2144,7 @@ env = Environment(F77PATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -2156,17 +2156,17 @@ env = Environment(F77PATH=include) The directory list will be added to command lines through the automatically-generated -$_F77INCFLAGS +&cv-link-_F77INCFLAGS; construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; construction variables to the beginning and end -of each directory in $F77PATH. +of each directory in &cv-link-F77PATH;. Any command lines you define that need the F77PATH directory list should -include $_F77INCFLAGS: +include &cv-link-_F77INCFLAGS;: @@ -2181,11 +2181,11 @@ env = Environment(F77COM="my_compiler $_F77INCFLAGS -c -o $TARGET $SOURCE") 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 &cv-link-F77FLAGS; and &cv-link-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 &cv-link-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 &cv-link-FORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -2199,7 +2199,7 @@ for all Fortran versions. 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 not set, then $F77PPCOM or $FORTRANPPCOM +If not set, then &cv-link-F77PPCOM; or &cv-link-FORTRANPPCOM; (the command line) is displayed. @@ -2220,10 +2220,10 @@ F77 dialect will be used. By default, this is empty The Fortran 90 compiler. -You should normally set the $FORTRAN variable, +You should normally set the &cv-link-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 &cv-link-F90; if you need to use a specific compiler or compiler version for Fortran 90 files. @@ -2234,9 +2234,9 @@ or compiler version for Fortran 90 files. 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 &cv-link-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 &cv-link-FORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -2249,7 +2249,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 90 source file is compiled to an object file. -If not set, then $F90COM or $FORTRANCOM +If not set, then &cv-link-F90COM; or &cv-link-FORTRANCOM; (the command line) is displayed. @@ -2275,14 +2275,14 @@ Note that this variable does contain (or similar) include search path options -that scons generates automatically from $F90PATH. +that scons generates automatically from &cv-link-F90PATH;. See -$_F90INCFLAGS +&cv-link-_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 &cv-link-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 &cv-link-FORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2297,10 +2297,10 @@ for all Fortran versions. 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 &cv-link-_F90INCFLAGS; is created +by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end -of each directory in $F90PATH. +of each directory in &cv-link-F90PATH;. @@ -2312,15 +2312,15 @@ of each directory in $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 &cv-link-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 &cv-link-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 &cv-link-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 &cv-link-FORTRANPATH; variable, which specifies the include path for the default Fortran compiler for all Fortran versions. @@ -2332,7 +2332,7 @@ env = Environment(F90PATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -2344,17 +2344,17 @@ env = Environment(F90PATH=include) The directory list will be added to command lines through the automatically-generated -$_F90INCFLAGS +&cv-link-_F90INCFLAGS; construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; construction variables to the beginning and end -of each directory in $F90PATH. +of each directory in &cv-link-F90PATH;. Any command lines you define that need the F90PATH directory list should -include $_F90INCFLAGS: +include &cv-link-_F90INCFLAGS;: @@ -2369,11 +2369,11 @@ env = Environment(F90COM="my_compiler $_F90INCFLAGS -c -o $TARGET $SOURCE") 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 &cv-link-F90FLAGS; and &cv-link-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 &cv-link-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 &cv-link-FORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -2386,7 +2386,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 90 source file is compiled after first running the file through the C preprocessor. -If not set, then $F90PPCOM or $FORTRANPPCOM +If not set, then &cv-link-F90PPCOM; or &cv-link-FORTRANPPCOM; (the command line) is displayed. @@ -2407,10 +2407,10 @@ F90 dialect will be used. By default, this is empty The Fortran 95 compiler. -You should normally set the $FORTRAN variable, +You should normally set the &cv-link-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 &cv-link-F95; if you need to use a specific compiler or compiler version for Fortran 95 files. @@ -2421,9 +2421,9 @@ or compiler version for Fortran 95 files. 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 &cv-link-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 &cv-link-FORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -2436,7 +2436,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 95 source file is compiled to an object file. -If not set, then $F95COM or $FORTRANCOM +If not set, then &cv-link-F95COM; or &cv-link-FORTRANCOM; (the command line) is displayed. @@ -2462,14 +2462,14 @@ Note that this variable does contain (or similar) include search path options -that scons generates automatically from $F95PATH. +that scons generates automatically from &cv-link-F95PATH;. See -$_F95INCFLAGS +&cv-link-_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 &cv-link-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 &cv-link-FORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -2484,10 +2484,10 @@ for all Fortran versions. 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 &cv-link-_F95INCFLAGS; is created +by appending &cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end -of each directory in $F95PATH. +of each directory in &cv-link-F95PATH;. @@ -2499,15 +2499,15 @@ of each directory in $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 &cv-link-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 &cv-link-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 &cv-link-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 &cv-link-FORTRANPATH; variable, which specifies the include path for the default Fortran compiler for all Fortran versions. @@ -2519,7 +2519,7 @@ env = Environment(F95PATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -2531,17 +2531,17 @@ env = Environment(F95PATH=include) The directory list will be added to command lines through the automatically-generated -$_F95INCFLAGS +&cv-link-_F95INCFLAGS; construction variable, which is constructed by appending the values of the -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; construction variables to the beginning and end -of each directory in $F95PATH. +of each directory in &cv-link-F95PATH;. Any command lines you define that need the F95PATH directory list should -include $_F95INCFLAGS: +include &cv-link-_F95INCFLAGS;: @@ -2556,11 +2556,11 @@ env = Environment(F95COM="my_compiler $_F95INCFLAGS -c -o $TARGET $SOURCE") 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 &cv-link-F95FLAGS; and &cv-link-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 &cv-link-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 &cv-link-FORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -2574,7 +2574,7 @@ for all Fortran versions. 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 not set, then $F95PPCOM or $FORTRANPPCOM +If not set, then &cv-link-F95PPCOM; or &cv-link-FORTRANPPCOM; (the command line) is displayed. @@ -2616,11 +2616,11 @@ for all versions of Fortran. 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 &cv-link-FORTRANFLAGS;, +&cv-link-CPPFLAGS;, +&cv-link-_CPPDEFFLAGS;, +&cv-link-_FORTRANMODFLAG;, and +&cv-link-_FORTRANINCFLAGS; construction variables are included on this command line. @@ -2632,7 +2632,7 @@ are included on this command line. If set, the string displayed when a Fortran source file is compiled to an object file. -If not set, then $FORTRANCOM +If not set, then &cv-link-FORTRANCOM; (the command line) is displayed. @@ -2658,9 +2658,9 @@ Note that this variable does contain (or similar) include or module search path options -that scons generates automatically from $FORTRANPATH. +that scons generates automatically from &cv-link-FORTRANPATH;. See -$_FORTRANINCFLAGS and $_FORTRANMODFLAG, +&cv-link-_FORTRANINCFLAGS; and &cv-link-_FORTRANMODFLAG;, below, for the variables that expand those options. @@ -2675,11 +2675,11 @@ 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 &cv-link-_FORTRANINCFLAGS; is created by respectively prepending and appending -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; to the beginning and end -of each directory in $FORTRANPATH. +of each directory in &cv-link-FORTRANPATH;. @@ -2703,8 +2703,8 @@ for module files, as well. 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 &cv-link-FORTRANMODDIR; construction variables +when the &cv-link-_FORTRANMODFLAG; variables is automatically generated. @@ -2716,8 +2716,8 @@ when the $_FORTRANMODFLAG$FORTRANMODDIR construction variables -when the $_FORTRANMODFLAG variables is automatically generated. +in the &cv-link-FORTRANMODDIR; construction variables +when the &cv-link-_FORTRANMODFLAG; variables is automatically generated. @@ -2731,10 +2731,10 @@ 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 &cv-link-_FORTRANMODFLAG; is created by respectively prepending and appending -$FORTRANMODDIRPREFIX and $FORTRANMODDIRSUFFIX -to the beginning and end of the directory in $FORTRANMODDIR. +&cv-link-FORTRANMODDIRPREFIX; and &cv-link-FORTRANMODDIRSUFFIX; +to the beginning and end of the directory in &cv-link-FORTRANMODDIR;. @@ -2784,7 +2784,7 @@ 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 #: @@ -2794,7 +2794,7 @@ env = Environment(FORTRANPATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -2806,17 +2806,17 @@ env = Environment(FORTRANPATH=include) The directory list will be added to command lines through the automatically-generated -$_FORTRANINCFLAGS +&cv-link-_FORTRANINCFLAGS; construction variable, which is constructed by respectively prepending and appending the values of the -$INCPREFIX and $INCSUFFIX +&cv-link-INCPREFIX; and &cv-link-INCSUFFIX; construction variables to the beginning and end -of each directory in $FORTRANPATH. +of each directory in &cv-link-FORTRANPATH;. Any command lines you define that need the FORTRANPATH directory list should -include $_FORTRANINCFLAGS: +include &cv-link-_FORTRANINCFLAGS;: @@ -2831,11 +2831,11 @@ env = Environment(FORTRANCOM="my_compiler $_FORTRANINCFLAGS -c -o $TARGET $SOURC 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 &cv-link-FORTRANFLAGS;, +&cv-link-CPPFLAGS;, +&cv-link-_CPPDEFFLAGS;, +&cv-link-_FORTRANMODFLAG;, and +&cv-link-_FORTRANINCFLAGS; construction variables are included on this command line. @@ -2848,7 +2848,7 @@ construction variables are included on this command line. 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 not set, then $FORTRANPPCOM +If not set, then &cv-link-FORTRANPPCOM; (the command line) is displayed. @@ -2890,7 +2890,7 @@ The default list is: 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). + &cv-link-FRAMEWORKS;). For example: @@ -2918,7 +2918,7 @@ env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') On Mac OS X with gcc, an automatically-generated construction variable containing the linker command-line options corresponding to - $FRAMEWORKPATH. + &cv-link-FRAMEWORKPATH;. @@ -2928,7 +2928,7 @@ env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') On Mac OS X with gcc, the prefix to be used for the FRAMEWORKPATH entries. - (see $FRAMEWORKPATH). + (see &cv-link-FRAMEWORKPATH;). The default value is . @@ -2941,7 +2941,7 @@ env.AppendUnique(FRAMEWORKPATH='#myframeworkdir') On Mac OS X with gcc, the prefix to be used for linking in frameworks - (see $FRAMEWORKS). + (see &cv-link-FRAMEWORKS;). The default value is . @@ -2986,8 +2986,8 @@ env.AppendUnique(FRAMEWORKS=Split('System Cocoa SystemConfiguration')) the end of a command line building a loadable module. (This has been largely superseded by - the $FRAMEWORKPATH, $FRAMEWORKPATHPREFIX, - $FRAMEWORKPREFIX and $FRAMEWORKS variables + the &cv-link-FRAMEWORKPATH;, &cv-link-FRAMEWORKPATHPREFIX;, + &cv-link-FRAMEWORKPREFIX; and &cv-link-FRAMEWORKS; variables described above.) @@ -3018,7 +3018,7 @@ value is $GS $GSFLAGS -sOutputFile=$TARGET $SOURCES 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 &cv-link-GSCOM; (the command line) is displayed. @@ -3046,7 +3046,7 @@ constructor; setting it later has no effect. -Valid values are the same as for $TARGET_ARCH. +Valid values are the same as for &cv-TARGET_ARCH;. @@ -3098,9 +3098,9 @@ The default list is: IMPLIBNOVERSIONSYMLINKS -Used to override $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS when +Used to override &cv-link-SHLIBNOVERSIONSYMLINKS;/&cv-link-LDMODULENOVERSIONSYMLINKS; when creating versioned import library for a shared library/loadable module. If not defined, -then $SHLIBNOVERSIONSYMLINKS/$LDMODULENOVERSIONSYMLINKS is used to determine +then &cv-link-SHLIBNOVERSIONSYMLINKS;/&cv-link-LDMODULENOVERSIONSYMLINKS; is used to determine whether to disable symlink generation or not. @@ -3112,8 +3112,8 @@ whether to disable symlink generation or not. 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 &t-link-cyglink; linker sets +&cv-link-IMPLIBPREFIX; to 'lib' and &cv-link-SHLIBPREFIX; to 'cyg'. @@ -3125,8 +3125,8 @@ to 'cyg'. 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 &t-link-cyglink; linker sets +&cv-link-IMPLIBSUFFIX; to '.dll.a' and &cv-link-SHLIBSUFFIX; to '.dll'. @@ -3136,9 +3136,9 @@ to '.dll'. IMPLIBVERSION -Used to override $SHLIBVERSION/$LDMODULEVERSION when +Used to override &cv-link-SHLIBVERSION;/&cv-link-LDMODULEVERSION; when generating versioned import library for a shared library/loadable module. If -undefined, the $SHLIBVERSION/$LDMODULEVERSION is used to +undefined, the &cv-link-SHLIBVERSION;/&cv-link-LDMODULEVERSION; is used to determine the version of versioned import library. @@ -3160,7 +3160,7 @@ an implicit dependency on the command 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 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 @@ -3168,10 +3168,10 @@ found by searching the PATH variable in the ENV dictionary -in the construction environment used to execute the command. +in the &consenv; used to execute the command. The default is the same as -setting the construction variable -$IMPLICIT_COMMAND_DEPENDENCIES +setting the &consvar; +&cv-IMPLICIT_COMMAND_DEPENDENCIES; to a True-like value (true, yes, or 1 - but not a number @@ -3186,12 +3186,12 @@ In a segemented string, each segment is a separate 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 +behavior of &cv-IMPLICIT_COMMAND_DEPENDENCIES; is applied to each segment. -If $IMPLICIT_COMMAND_DEPENDENCIES +If &cv-IMPLICIT_COMMAND_DEPENDENCIES; is set to a False-like value (none, false, @@ -3200,38 +3200,38 @@ is set to a False-like value etc.), then the implicit dependency will not be added to the targets -built with that construction environment. +built with that &consenv;. -If $IMPLICIT_COMMAND_DEPENDENCIES +If &cv-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. +with that &consenv;. 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. +in the &consenv; 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 +If &cv-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. +with that &consenv;. 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. +in the &consenv; 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. @@ -3250,8 +3250,8 @@ env = Environment(IMPLICIT_COMMAND_DEPENDENCIES=False) 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 &cv-CPPPATH; and &cv-FORTRANPATH; construction variables +when the &cv-_CPPINCFLAGS; and &cv-_FORTRANINCFLAGS; variables are automatically generated. @@ -3264,8 +3264,8 @@ variables are automatically generated. 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 &cv-CPPPATH; and &cv-FORTRANPATH; construction variables +when the &cv-_CPPINCFLAGS; and &cv-_FORTRANINCFLAGS; variables are automatically generated. @@ -3361,7 +3361,7 @@ The command line used to call the Java archive tool. The string displayed when the Java archive tool is called -If this is not set, then $JARCOM (the command line) is displayed. +If this is not set, then &cv-link-JARCOM; (the command line) is displayed. @@ -3401,7 +3401,7 @@ by default. 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 @@ -3428,7 +3428,7 @@ by default. 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 &cv-link-JAVACFLAGS; construction variable are included on this command line. @@ -3441,7 +3441,7 @@ by default. 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 &cv-link-JAVACCOM; (the command line) is displayed. @@ -3481,7 +3481,7 @@ env = Environment(JAVACCOMSTR="Compiling class files $TARGETS from $SOURCES") .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 @@ -3493,8 +3493,8 @@ env = Environment(JAVACCOMSTR="Compiling class files $TARGETS from $SOURCES") 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 + &cv-JAVACLASSPATH; directories for dependency .class files. @@ -3527,7 +3527,7 @@ The Java generator for C header and stub files. 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 &cv-link-JAVAHFLAGS; construction variable are included on this command line. @@ -3539,7 +3539,7 @@ are included on this command line. 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 &cv-link-JAVAHCOM; (the command line) is displayed. @@ -3576,7 +3576,7 @@ for Java classes. .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 @@ -3588,8 +3588,8 @@ for Java classes. 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 + &cv-JAVASOURCEPATH; directories for dependency .java files. @@ -3611,11 +3611,11 @@ for Java classes. JAVAVERSION - Specifies the Java version being used by the Java builder. + Specifies the Java version being used by the &b-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. @@ -3624,11 +3624,11 @@ for Java classes. 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 &cv-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. @@ -3658,7 +3658,7 @@ The command line used to call the LaTeX structured formatter and typesetter. 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 &cv-link-LATEXCOM; (the command line) is displayed. @@ -3683,7 +3683,7 @@ General options passed to the LaTeX structured formatter and typesetter. The maximum number of times that LaTeX will be re-run if the .log -generated by the $LATEXCOM command +generated by the &cv-link-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. @@ -3712,7 +3712,7 @@ The default list is: The linker for building loadable modules. -By default, this is the same as $SHLINK. +By default, this is the same as &cv-link-SHLINK;. @@ -3722,10 +3722,10 @@ By default, this is the same as $SHLINK 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 &cv-link-LDMODULE;, +&cv-link-LDMODULEFLAGS; and +&cv-link-FRAMEWORKSFLAGS; variables. +On other systems, this is the same as &cv-link-SHLINK;. @@ -3735,7 +3735,7 @@ On other systems, this is the same as $SHLINK If set, the string displayed when building loadable modules. -If not set, then $LDMODULECOM (the command line) is displayed. +If not set, then &cv-link-LDMODULECOM; (the command line) is displayed. @@ -3745,7 +3745,7 @@ If not set, then $LDMODULECOM Contains the emitter specification for the -LoadableModule builder. +&b-link-LoadableModule; builder. The manpage section "Builder Objects" contains general information on specifying emitters. @@ -3765,7 +3765,7 @@ General user options passed to the linker for building loadable modules. LDMODULENOVERSIONSYMLINKS -Instructs the LoadableModule builder to not automatically create symlinks +Instructs the &b-link-LoadableModule; builder to not automatically create symlinks for versioned modules. Defaults to $SHLIBNOVERSIONSYMLINKS @@ -3778,7 +3778,7 @@ for versioned modules. Defaults to $SHLIBNOVERSIONSYMLINKS 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 &cv-link-SHLIBPREFIX;. @@ -3788,8 +3788,8 @@ the same as $SHLIBPREFIX. 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 &b-link-LoadableModule; builder +when the linker tool supports SONAME (e.g. &t-link-gnulink;). @@ -3811,11 +3811,11 @@ the same as $SHLIBSUFFIX. 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 &b-link-LoadableModule; builder. This activates the +&cv-link-_LDMODULEVERSIONFLAGS; and thus modifies the &cv-link-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. +that are needed. &cv-link-LDMODULEVERSION; versions should exist in the same +format as &cv-link-SHLIBVERSION;. @@ -3824,10 +3824,10 @@ 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 +This macro automatically introduces extra flags to &cv-link-LDMODULECOM; when +building versioned &b-link-LoadableModule; (that is when +&cv-link-LDMODULEVERSION; is set). _LDMODULEVERSIONFLAGS +usually adds &cv-link-SHLIBVERSIONFLAGS; and some extra dynamically generated options (such as -Wl,-soname=$_LDMODULESONAME). It is unused by plain (unversioned) loadable modules. @@ -3838,8 +3838,8 @@ by plain (unversioned) loadable modules. LDMODULEVERSIONFLAGS -Extra flags added to $LDMODULECOM when building versioned -LoadableModule. These flags are only used when $LDMODULEVERSION is +Extra flags added to &cv-link-LDMODULECOM; when building versioned +&b-link-LoadableModule;. These flags are only used when &cv-link-LDMODULEVERSION; is set. @@ -3870,7 +3870,7 @@ to generate a source file. 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 &cv-link-LEXCOM; (the command line) is displayed. @@ -3904,10 +3904,10 @@ Used only on windows environments to set a lex flag to prevent 'unistd.h' from b 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 &cv-_LIBDIRFLAGS; is created +by respectively prepending and appending &cv-LIBDIRPREFIX; and &cv-LIBDIRSUFFIX; to the beginning and end -of each directory in $LIBPATH. +of each directory in &cv-LIBPATH;. @@ -3918,8 +3918,8 @@ of each directory in $LIBPATH. 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 &cv-LIBPATH; construction variable +when the &cv-_LIBDIRFLAGS; variable is automatically generated. @@ -3930,8 +3930,8 @@ when the $_LIBDIRFLAGS variable is automatically generated. 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 &cv-LIBPATH; construction variable +when the &cv-_LIBDIRFLAGS; variable is automatically generated. @@ -3941,7 +3941,7 @@ when the $_LIBDIRFLAGS variable is automatically generated. Contains the emitter specification for the -StaticLibrary builder. +&b-link-StaticLibrary; builder. The manpage section "Builder Objects" contains general information on specifying emitters. @@ -3955,10 +3955,10 @@ general information on specifying emitters. 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 &cv-_LIBFLAGS; is created +by respectively prepending and appending &cv-LIBLINKPREFIX; and &cv-LIBLINKSUFFIX; to the beginning and end -of each filename in $LIBS. +of each filename in &cv-LIBS;. @@ -3969,8 +3969,8 @@ of each filename in $LIBS. 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 &cv-LIBS; construction variable +when the &cv-_LIBFLAGS; variable is automatically generated. @@ -3981,8 +3981,8 @@ when the $_LIBFLAGS variable is automatically generated. 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 &cv-LIBS; construction variable +when the &cv-_LIBFLAGS; variable is automatically generated. @@ -3994,12 +3994,12 @@ when the $_LIBFLAGS variable is automatically generated. 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 &cv-LINKFLAGS; or &cv-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 #: @@ -4009,7 +4009,7 @@ env = Environment(LIBPATH='#/libs') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -4021,17 +4021,17 @@ env = Environment(LIBPATH=libs) The directory list will be added to command lines through the automatically-generated -$_LIBDIRFLAGS +&cv-_LIBDIRFLAGS; construction variable, which is constructed by respectively prepending and appending the values of the -$LIBDIRPREFIX and $LIBDIRSUFFIX +&cv-LIBDIRPREFIX; and &cv-LIBDIRSUFFIX; construction variables to the beginning and end -of each directory in $LIBPATH. +of each directory in &cv-LIBPATH;. Any command lines you define that need the LIBPATH directory list should -include $_LIBDIRFLAGS: +include &cv-_LIBDIRFLAGS;: @@ -4062,7 +4062,7 @@ 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 &cv-LIBSUFFIXES; list. @@ -4080,17 +4080,17 @@ created by this environment. The library list will be added to command lines through the automatically-generated -$_LIBFLAGS +&cv-_LIBFLAGS; construction variable, which is constructed by respectively prepending and appending the values of the -$LIBLINKPREFIX and $LIBLINKSUFFIX +&cv-LIBLINKPREFIX; and &cv-LIBLINKSUFFIX; construction variables to the beginning and end -of each filename in $LIBS. +of each filename in &cv-LIBS;. Any command lines you define that need the LIBS library list should -include $_LIBFLAGS: +include &cv-_LIBFLAGS;: @@ -4101,13 +4101,13 @@ env = Environment(LINKCOM="my_linker $_LIBDIRFLAGS $_LIBFLAGS -o $TARGET $SOURCE If you add a File object to the -$LIBS +&cv-LIBS; list, the name of that file will be added to -$_LIBFLAGS, +&cv-_LIBFLAGS;, and thus the link line, as is, without -$LIBLINKPREFIX +&cv-LIBLINKPREFIX; or -$LIBLINKSUFFIX. +&cv-LIBLINKSUFFIX;. For example: @@ -4142,7 +4142,7 @@ to reflect the names of the libraries they create. 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 &cv-LIBPREFIXES; list, the base library name, and these suffixes. @@ -4165,7 +4165,7 @@ for a list of license names and SPDX codes. LINESEPARATOR -The separator used by the Substfile and Textfile builders. +The separator used by the &b-Substfile; and &b-Textfile; builders. This value is used between sources when constructing the target. It defaults to the current system line separator. @@ -4176,11 +4176,11 @@ 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 +The &cv-LINGUAS_FILE; defines file(s) containing list of additional linguas +to be processed by &b-link-POInit;, &b-link-POUpdate; or &b-link-MOFiles; +builders. It also affects &b-link-Translate; builder. If the variable contains +a string, it defines name of the list file. The &cv-LINGUAS_FILE; may be a +list of file names as well. If &cv-LINGUAS_FILE; is set to True (or non-zero numeric value), the list will be read from default file named LINGUAS. @@ -4194,7 +4194,7 @@ default file named The linker. -See also $SHLINK for linking shared objects. +See also &cv-link-SHLINK; for linking shared objects. @@ -4204,7 +4204,7 @@ See also $SHLINK for linking sha The command line used to link object files into an executable. -See also $SHLINKCOM for linking shared objects. +See also &cv-link-SHLINKCOM; for linking shared objects. @@ -4215,8 +4215,8 @@ See also $SHLINKCOM for linki If set, the string displayed when object files are linked into an executable. -If not set, then $LINKCOM (the command line) is displayed. -See also $SHLINKCOMSTR. for linking shared objects. +If not set, then &cv-link-LINKCOM; (the command line) is displayed. +See also &cv-link-SHLINKCOMSTR;. for linking shared objects. @@ -4234,20 +4234,20 @@ 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 &cv-link-LIBS;, nor (or similar) library search path options -that scons generates automatically from $LIBPATH. +that scons generates automatically from &cv-link-LIBPATH;. See -$_LIBFLAGS +&cv-link-_LIBFLAGS; above, for the variable that expands to library-link options, and -$_LIBDIRFLAGS +&cv-link-_LIBDIRFLAGS; above, for the variable that expands to library search path options. -See also $SHLINKFLAGS. for linking shared objects. +See also &cv-link-SHLINKFLAGS;. for linking shared objects. @@ -4276,7 +4276,7 @@ The command line used to pass files through the M4 macro preprocessor. 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 &cv-link-M4COM; (the command line) is displayed. @@ -4318,7 +4318,7 @@ typesetter. 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 &cv-link-MAKEINDEXCOM; (the command line) is displayed. @@ -4369,7 +4369,7 @@ The command line used to pass files to the Microsoft IDL compiler. 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 &cv-link-MIDLCOM; (the command line) is displayed. @@ -4388,7 +4388,7 @@ General options passed to the Microsoft IDL compiler. Suffix used for MO files (default: '.mo'). -See msgfmt tool and MOFiles builder. +See &t-link-msgfmt; tool and &b-link-MOFiles; builder. @@ -4399,7 +4399,7 @@ See msgfmt tool and Absolute path to msgfmt(1) binary, found by Detect(). -See msgfmt tool and MOFiles builder. +See &t-link-msgfmt; tool and &b-link-MOFiles; builder. @@ -4409,7 +4409,7 @@ See msgfmt tool and Complete command line to run msgfmt(1) program. -See msgfmt tool and MOFiles builder. +See &t-link-msgfmt; tool and &b-link-MOFiles; builder. @@ -4419,8 +4419,8 @@ See msgfmt tool and String to display when msgfmt(1) is invoked -(default: '', which means ``print $MSGFMTCOM''). -See msgfmt tool and MOFiles builder. +(default: '', which means ``print &cv-link-MSGFMTCOM;''). +See &t-link-msgfmt; tool and &b-link-MOFiles; builder. @@ -4430,7 +4430,7 @@ See msgfmt tool and Additional flags to msgfmt(1). -See msgfmt tool and MOFiles builder. +See &t-link-msgfmt; tool and &b-link-MOFiles; builder. @@ -4441,7 +4441,7 @@ See msgfmt tool and Path to msginit(1) program (found via Detect()). -See msginit tool and POInit builder. +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -4451,7 +4451,7 @@ See msginit tool and Complete command line to run msginit(1) program. -See msginit tool and POInit builder. +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -4461,8 +4461,8 @@ See msginit tool and String to display when msginit(1) is invoked -(default: '', which means ``print $MSGINITCOM''). -See msginit tool and POInit builder. +(default: '', which means ``print &cv-link-MSGINITCOM;''). +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -4473,7 +4473,7 @@ See msginit tool and List of additional flags to msginit(1) (default: []). -See msginit tool and POInit builder. +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -4486,7 +4486,7 @@ Internal ``macro''. Computes locale (language) name based on target filename (default: '${TARGET.filebase}' ). -See msginit tool and POInit builder. +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -4497,7 +4497,7 @@ See msginit tool and Absolute path to msgmerge(1) binary as found by Detect(). -See msgmerge tool and POUpdate builder. +See &t-link-msgmerge; tool and &b-link-POUpdate; builder. @@ -4507,7 +4507,7 @@ See msgmerge tool and Complete command line to run msgmerge(1) command. -See msgmerge tool and POUpdate builder. +See &t-link-msgmerge; tool and &b-link-POUpdate; builder. @@ -4517,8 +4517,8 @@ See msgmerge tool and String to be displayed when msgmerge(1) is invoked -(default: '', which means ``print $MSGMERGECOM''). -See msgmerge tool and POUpdate builder. +(default: '', which means ``print &cv-link-MSGMERGECOM;''). +See &t-link-msgmerge; tool and &b-link-POUpdate; builder. @@ -4528,7 +4528,7 @@ See msgmerge tool and Additional flags to msgmerge(1) command. -See msgmerge tool and POUpdate builder. +See &t-link-msgmerge; tool and &b-link-POUpdate; builder. @@ -4576,7 +4576,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 &cv-link-CHANGED_SOURCES; construction variable). Any compilations where the object (target) file base name (minus the .obj) does not match the source file base name @@ -4593,7 +4593,7 @@ Use a batch script to set up Microsoft Visual Studio compiler -$MSVC_USE_SCRIPT overrides $MSVC_VERSION and $TARGET_ARCH. +&cv-MSVC_USE_SCRIPT; overrides &cv-MSVC_VERSION; and &cv-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 @@ -4612,7 +4612,7 @@ 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 &cv-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. @@ -4636,7 +4636,7 @@ Sets the preferred version of Microsoft Visual C/C++ to use. -If $MSVC_VERSION is not set, SCons will (by default) select the +If &cv-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() @@ -4681,7 +4681,7 @@ Versions ending in Exp refer to "Express" or VERSION the version of MSVS being used (can be set via - $MSVS_VERSION) + &cv-link-MSVS_VERSION;) VERSIONS @@ -4747,11 +4747,11 @@ Versions ending in Exp refer to "Express" or 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 &cv-MSVS_ARCH; to an architecture that's not supported for a given Visual Studio version will generate an error. @@ -4850,7 +4850,7 @@ no default value. Sets the preferred version of Microsoft Visual Studio to use. - If $MSVS_VERSION is not set, SCons will (by default) + If &cv-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 @@ -4860,10 +4860,10 @@ no default value. 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 &cv-MSVC_VERSION; instead. If + &cv-MSVS_VERSION; is set and &cv-MSVC_VERSION; is + not, &cv-MSVC_VERSION; will be set automatically to + &cv-MSVS_VERSION;. If both are set to different values, scons will raise an error. @@ -4960,11 +4960,11 @@ no default value. MSVSSCONSCRIPT - The sconscript file (that is, SConstruct or SConscript + 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 &cv-link-MSVSSCONSCOM; variable). The default is the same sconscript file that contains the call to - MSVSProject to build the project file. + &b-MSVSProject; to build the project file. @@ -5003,7 +5003,7 @@ no default value. The program used on Windows systems to embed manifests into DLLs and EXEs. -See also $WINDOWS_EMBED_MANIFEST. +See also &cv-link-WINDOWS_EMBED_MANIFEST;. @@ -5013,7 +5013,7 @@ See also $WINDOWS_EMBED_MANIFES The Windows command line used to embed manifests into executables. -See also $MTSHLIBCOM. +See also &cv-link-MTSHLIBCOM;. @@ -5022,7 +5022,7 @@ See also $MTSHLIBCOM. MTFLAGS -Flags passed to the $MT manifest embedding program (Windows only). +Flags passed to the &cv-link-MT; manifest embedding program (Windows only). @@ -5032,7 +5032,7 @@ Flags passed to the $MT manifest emb The Windows command line used to embed manifests into shared libraries (DLLs). -See also $MTEXECOM. +See also &cv-link-MTEXECOM;. @@ -5176,7 +5176,7 @@ env['PCH'] = 'StdAfx.pch' The command line used by the -PCH +&b-PCH; builder to generated a precompiled header. @@ -5187,7 +5187,7 @@ builder to generated a precompiled header. 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 &cv-link-PCHCOM; (the command line) is displayed. @@ -5198,7 +5198,7 @@ If this is not set, then $PCHCOM 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 &cv-PDB; construction variable is set. @@ -5251,7 +5251,7 @@ 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 &cv-link-CCPDBFLAGS; variable; see the entry for that variable for specific examples. @@ -5261,7 +5261,7 @@ see the entry for that variable for specific examples. PDFCOM -A deprecated synonym for $DVIPDFCOM. +A deprecated synonym for &cv-link-DVIPDFCOM;. @@ -5270,7 +5270,7 @@ A deprecated synonym for $DVIPDFCOM< PDFLATEX -The pdflatex utility. +The &pdflatex; utility. @@ -5279,7 +5279,7 @@ The pdflatex utility. PDFLATEXCOM -The command line used to call the pdflatex utility. +The command line used to call the &pdflatex; utility. @@ -5288,8 +5288,8 @@ 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. +The string displayed when calling the &pdflatex; utility. +If this is not set, then &cv-link-PDFLATEXCOM; (the command line) is displayed. @@ -5302,7 +5302,7 @@ env = Environment(PDFLATEX;COMSTR = "Building $TARGET from LaTeX input $SOURCES" PDFLATEXFLAGS -General options passed to the pdflatex utility. +General options passed to the &pdflatex; utility. @@ -5329,7 +5329,7 @@ The suffix used for PDF file names. PDFTEX -The pdftex utility. +The &pdftex; utility. @@ -5338,7 +5338,7 @@ The pdftex utility. PDFTEXCOM -The command line used to call the pdftex utility. +The command line used to call the &pdftex; utility. @@ -5347,8 +5347,8 @@ 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. +The string displayed when calling the &pdftex; utility. +If this is not set, then &cv-link-PDFTEXCOM; (the command line) is displayed. @@ -5361,7 +5361,7 @@ env = Environment(PDFTEXCOMSTR = "Building $TARGET from TeX input $SOURCES") PDFTEXFLAGS -General options passed to the pdftex utility. +General options passed to the &pdftex; utility. @@ -5372,7 +5372,7 @@ General options passed to the pdftex utility. On Solaris systems, the package-checking program that will -be used (along with $PKGINFO) +be used (along with &cv-PKGINFO;) to look for installed versions of the Sun PRO C++ compiler. The default is @@ -5387,7 +5387,7 @@ The default is On Solaris systems, the package information program that will -be used (along with $PKGCHK) +be used (along with &cv-PKGCHK;) to look for installed versions of the Sun PRO C++ compiler. The default is @@ -5402,7 +5402,7 @@ The default is 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. @@ -5420,11 +5420,11 @@ else: POAUTOINIT -The $POAUTOINIT variable, if set to True (on non-zero -numeric value), let the msginit tool to automatically initialize +The &cv-POAUTOINIT; variable, if set to True (on non-zero +numeric value), let the &t-link-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 +&b-link-POInit; and &b-link-POUpdate; builders (and others that use any of them). @@ -5434,9 +5434,9 @@ them). POCREATE_ALIAS -Common alias for all PO files created with POInit +Common alias for all PO files created with &b-POInit; builder (default: 'po-create'). -See msginit tool and POInit builder. +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -5446,7 +5446,7 @@ See msginit tool and Suffix used for PO files (default: '.po') -See msginit tool and POInit builder. +See &t-link-msginit; tool and &b-link-POInit; builder. @@ -5455,11 +5455,11 @@ See msginit tool and POTDOMAIN -The $POTDOMAIN defines default domain, used to generate -POT filename as $POTDOMAIN.pot when +The &cv-POTDOMAIN; defines default domain, used to generate +POT filename as &cv-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 +&b-link-POTUpdate;, &b-link-POInit; and &b-link-POUpdate; builders (and +builders, that use them, e.g. &b-Translate;). Normally (if &cv-POTDOMAIN; is not defined), the builders use messages.pot as default POT file name. @@ -5471,7 +5471,7 @@ not defined), the builders use messages.pot as default Suffix used for PO Template files (default: '.pot'). -See xgettext tool and POTUpdate builder. +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -5481,8 +5481,8 @@ See xgettext tool and Name of the common phony target for all PO Templates created with -POUpdate (default: 'pot-update'). -See xgettext tool and POTUpdate builder. +&b-link-POUpdate; (default: 'pot-update'). +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -5492,8 +5492,8 @@ See xgettext tool and Common alias for all PO files being defined with -POUpdate builder (default: 'po-update'). -See msgmerge tool and POUpdate builder. +&b-link-POUpdate; builder (default: 'po-update'). +See &t-link-msgmerge; tool and &b-link-POUpdate; builder. @@ -5555,7 +5555,7 @@ for example. Contains the emitter specification for the -Program builder. +&b-link-Program; builder. The manpage section "Builder Objects" contains general information on specifying emitters. @@ -5595,7 +5595,7 @@ The command line used to convert TeX DVI files into a PostScript file. 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 &cv-link-PSCOM; (the command line) is displayed. @@ -5633,7 +5633,7 @@ specify files to run moc on. The path where the qt binaries are installed. -The default value is '$QTDIR/bin'. +The default value is '&cv-link-QTDIR;/bin'. @@ -5643,9 +5643,9 @@ The default value is '$QTDIR/bin' The path where the qt header files are installed. -The default value is '$QTDIR/include'. +The default value is '&cv-link-QTDIR;/include'. Note: If you set this variable to None, -the tool won't change the $CPPPATH +the tool won't change the &cv-link-CPPPATH; construction variable. @@ -5665,7 +5665,7 @@ Prints lots of debugging information while scanning for moc files. 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 &cv-link-LIBS; variable. @@ -5675,9 +5675,9 @@ this variable to None, the tool won't change the The path where the qt libraries are installed. -The default value is '$QTDIR/lib'. +The default value is '&cv-link-QTDIR;/lib'. Note: If you set this variable to None, -the tool won't change the $LIBPATH +the tool won't change the &cv-link-LIBPATH; construction variable. @@ -5687,7 +5687,7 @@ construction variable. QT_MOC -Default value is '$QT_BINPATH/moc'. +Default value is '&cv-link-QT_BINPATH;/moc'. @@ -5725,7 +5725,7 @@ Command to generate a moc file from a cpp file. 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 &cv-link-QT_MOCFROMCXXCOM; (the command line) is displayed. @@ -5754,7 +5754,7 @@ Command to generate a moc file from a header. 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 &cv-link-QT_MOCFROMHCOM; (the command line) is displayed. @@ -5782,7 +5782,7 @@ 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 +Default value is '&cv-link-CXXFILESUFFIX;'. Suffix for moc output files, when source is a header. @@ -5792,7 +5792,7 @@ a header. QT_UIC -Default value is '$QT_BINPATH/uic'. +Default value is '&cv-link-QT_BINPATH;/uic'. @@ -5811,7 +5811,7 @@ Command to generate header files from .ui files. 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 &cv-link-QT_UICCOM; (the command line) is displayed. @@ -5867,7 +5867,7 @@ Default value is 'uic_'. Prefix for uic generated implementation files. QT_UICIMPLSUFFIX -Default value is '$CXXFILESUFFIX'. Suffix for uic generated implementation +Default value is '&cv-link-CXXFILESUFFIX;'. Suffix for uic generated implementation files. @@ -5894,11 +5894,11 @@ 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 &cv-link-CPPPATH;, +&cv-link-LIBPATH; and +&cv-link-LIBS; may be modified and the variables -$PROGEMITTER, $SHLIBEMITTER and $LIBEMITTER +&cv-link-PROGEMITTER;, &cv-link-SHLIBEMITTER; and &cv-link-LIBEMITTER; are modified. Because the build-performance is affected when using this tool, you have to explicitly specify it at Environment creation: @@ -5919,7 +5919,7 @@ 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() +&b-Moc;() builder method. @@ -5932,7 +5932,7 @@ 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 +&b-Moc; builder method. @@ -5944,7 +5944,7 @@ 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 +&b-Uic; builder method. @@ -5973,7 +5973,7 @@ The command line used to index a static library archive. 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 &cv-link-RANLIBCOM; (the command line) is displayed. @@ -6017,7 +6017,7 @@ a Microsoft Visual C++ resource file. 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 &cv-link-RCCOM; (the command line) is displayed. @@ -6039,11 +6039,11 @@ 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 &cv-RCINCFLAGS; is created by respectively prepending and appending -$RCINCPREFIX and $RCINCSUFFIX +&cv-RCINCPREFIX; and &cv-RCINCSUFFIX; to the beginning and end -of each directory in $CPPPATH. +of each directory in &cv-CPPPATH;. @@ -6055,8 +6055,8 @@ of each directory in $CPPPATH. 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 &cv-CPPPATH; construction variable +when the &cv-RCINCFLAGS; variable is expanded. @@ -6068,8 +6068,8 @@ when the $RCINCFLAGS variable is expanded. 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 &cv-CPPPATH; construction variable +when the &cv-RCINCFLAGS; variable is expanded. @@ -6090,7 +6090,7 @@ searching the repositories. The program used on Windows systems to register a newly-built DLL library -whenever the SharedLibrary builder +whenever the &b-SharedLibrary; builder is passed a keyword argument of register=1. @@ -6102,7 +6102,7 @@ is passed a keyword argument of register=1. The command line used on Windows systems to register a newly-built DLL library -whenever the SharedLibrary builder +whenever the &b-SharedLibrary; builder is passed a keyword argument of register=1. @@ -6113,7 +6113,7 @@ is passed a keyword argument of register=1. 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 &cv-link-REGSVRCOM; (the command line) is displayed. @@ -6148,7 +6148,7 @@ The Java RMI stub compiler. 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 &cv-link-RMICFLAGS; construction variable are included on this command line. @@ -6161,7 +6161,7 @@ are included on this command line. 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 &cv-link-RMICCOM; (the command line) is displayed. @@ -6189,7 +6189,7 @@ 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. @@ -6203,10 +6203,10 @@ path, you must make it absolute yourself. 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 +The value of &cv-_RPATH; is created +by respectively prepending &cv-RPATHPREFIX; and appending &cv-RPATHSUFFIX; to the beginning and end -of each directory in $RPATH. +of each directory in &cv-RPATH;. @@ -6218,8 +6218,8 @@ of each directory in $RPATH. 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 &cv-RPATH; construction variable +when the &cv-_RPATH; variable is automatically generated. @@ -6231,8 +6231,8 @@ when the $_RPATH variable is automatically generated. 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 &cv-RPATH; construction variable +when the &cv-_RPATH; variable is automatically generated. @@ -6253,7 +6253,7 @@ The RPC protocol compiler. Options passed to the RPC protocol compiler when generating client side stubs. These are in addition to any flags specified in the -$RPCGENFLAGS +&cv-link-RPCGENFLAGS; construction variable. @@ -6275,7 +6275,7 @@ General options passed to the RPC protocol compiler. Options passed to the RPC protocol compiler when generating a header file. These are in addition to any flags specified in the -$RPCGENFLAGS +&cv-link-RPCGENFLAGS; construction variable. @@ -6288,7 +6288,7 @@ construction variable. Options passed to the RPC protocol compiler when generating server side stubs. These are in addition to any flags specified in the -$RPCGENFLAGS +&cv-link-RPCGENFLAGS; construction variable. @@ -6301,7 +6301,7 @@ construction variable. Options passed to the RPC protocol compiler when generating XDR routines. These are in addition to any flags specified in the -$RPCGENFLAGS +&cv-link-RPCGENFLAGS; construction variable. @@ -6331,7 +6331,7 @@ for more information. 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 &cv-link-MSVSSCONS; command line executed from Microsoft Visual Studio project files. @@ -6342,7 +6342,7 @@ for more information. The C compiler used for generating shared-library objects. -See also $CC for compiling to static objects. +See also &cv-link-CC; for compiling to static objects. @@ -6353,11 +6353,11 @@ See also $CC for compiling to static 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 &cv-link-SHCFLAGS;, +&cv-link-SHCCFLAGS; and +&cv-link-CPPFLAGS; construction variables are included on this command line. -See also $CCCOM for compiling to static objects. +See also &cv-link-CCCOM; for compiling to static objects. @@ -6368,8 +6368,8 @@ See also $CCCOM for compiling to If set, the string displayed when a C source file is compiled to a shared object file. -If not set, then $SHCCCOM (the command line) is displayed. -See also $CCCOMSTR for compiling to static objects. +If not set, then &cv-link-SHCCCOM; (the command line) is displayed. +See also &cv-link-CCCOMSTR; for compiling to static objects. @@ -6384,7 +6384,7 @@ env = Environment(SHCCCOMSTR = "Compiling shared object $TARGET") Options that are passed to the C and C++ compilers to generate shared-library objects. -See also $CCFLAGS for compiling to static objects. +See also &cv-link-CCFLAGS; for compiling to static objects. @@ -6395,7 +6395,7 @@ See also $CCFLAGS for compiling Options that are passed to the C compiler (only; not C++) to generate shared-library objects. -See also $CFLAGS for compiling to static objects. +See also &cv-link-CFLAGS; for compiling to static objects. @@ -6405,7 +6405,7 @@ See also $CFLAGS for compiling t The C++ compiler used for generating shared-library objects. -See also $CXX for compiling to static objects. +See also &cv-link-CXX; for compiling to static objects. @@ -6416,10 +6416,10 @@ See also $CXX for compiling to stat 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 &cv-link-SHCXXFLAGS; and +&cv-link-CPPFLAGS; construction variables are included on this command line. -See also $CXXCOM for compiling to static objects. +See also &cv-link-CXXCOM; for compiling to static objects. @@ -6430,8 +6430,8 @@ See also $CXXCOM for compiling t If set, the string displayed when a C++ source file is compiled to a shared object file. -If not set, then $SHCXXCOM (the command line) is displayed. -See also $CXXCOMSTR for compiling to static objects. +If not set, then &cv-link-SHCXXCOM; (the command line) is displayed. +See also &cv-link-CXXCOMSTR; for compiling to static objects. @@ -6446,7 +6446,7 @@ env = Environment(SHCXXCOMSTR = "Compiling shared object $TARGET") Options that are passed to the C++ compiler to generate shared-library objects. -See also $CXXFLAGS for compiling to static objects. +See also &cv-link-CXXFLAGS; for compiling to static objects. @@ -6457,7 +6457,7 @@ See also $CXXFLAGS for compili 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. +See also &cv-link-DC; for compiling to static objects. @@ -6467,7 +6467,7 @@ See also $DC for compiling to static The command line to use when compiling code to be part of shared objects. -See also $DCOM for compiling to static objects. +See also &cv-link-DCOM; for compiling to static objects. @@ -6478,8 +6478,8 @@ See also $DCOM for compiling to st 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. +If not set, then &cv-link-SHDCOM; (the command line) is displayed. +See also &cv-link-DCOMSTR; for compiling to static objects. @@ -6508,7 +6508,7 @@ SHDLIBVERSIONFLAGS. The linker to use when creating shared objects for code bases include D sources. -See also $DLINK for linking static objects. +See also &cv-link-DLINK; for linking static objects. @@ -6518,7 +6518,7 @@ See also $DLINK for linking stati The command line to use when generating shared objects. -See also $DLINKCOM for linking static objects. +See also &cv-link-DLINKCOM; for linking static objects. @@ -6528,7 +6528,7 @@ See also $DLINKCOM for linking The list of flags to use when generating a shared object. -See also $DLINKFLAGS for linking static objects. +See also &cv-link-DLINKFLAGS; for linking static objects. @@ -6538,10 +6538,10 @@ See also $DLINKFLAGS for lin A string naming the shell program that will be passed to the -$SPAWN +&cv-SPAWN; function. See the -$SPAWN +&cv-SPAWN; construction variable for more information. @@ -6552,10 +6552,10 @@ construction variable for more information. The Fortran 03 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the &cv-link-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 &cv-link-SHF03; if you need to use a specific compiler or compiler version for Fortran 03 files. @@ -6567,9 +6567,9 @@ or compiler version for Fortran 03 files. 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 &cv-link-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 &cv-link-SHFORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -6582,7 +6582,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 03 source file is compiled to a shared-library object file. -If not set, then $SHF03COM or $SHFORTRANCOM +If not set, then &cv-link-SHF03COM; or &cv-link-SHFORTRANCOM; (the command line) is displayed. @@ -6594,9 +6594,9 @@ If not set, then $SHF03COM or 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 &cv-link-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 &cv-link-SHFORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6611,11 +6611,11 @@ for all Fortran versions. 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 &cv-link-SHF03FLAGS; and &cv-link-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 &cv-link-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 &cv-link-SHFORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -6629,7 +6629,7 @@ for all Fortran versions. 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 not set, then $SHF03PPCOM or $SHFORTRANPPCOM +If not set, then &cv-link-SHF03PPCOM; or &cv-link-SHFORTRANPPCOM; (the command line) is displayed. @@ -6640,10 +6640,10 @@ If not set, then $SHF03PPCOM The Fortran 08 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the &cv-link-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 &cv-link-SHF08; if you need to use a specific compiler or compiler version for Fortran 08 files. @@ -6655,9 +6655,9 @@ or compiler version for Fortran 08 files. 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 &cv-link-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 &cv-link-SHFORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -6670,7 +6670,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 08 source file is compiled to a shared-library object file. -If not set, then $SHF08COM or $SHFORTRANCOM +If not set, then &cv-link-SHF08COM; or &cv-link-SHFORTRANCOM; (the command line) is displayed. @@ -6682,9 +6682,9 @@ If not set, then $SHF08COM or 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 &cv-link-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 &cv-link-SHFORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6699,11 +6699,11 @@ for all Fortran versions. 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 &cv-link-SHF08FLAGS; and &cv-link-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 &cv-link-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 &cv-link-SHFORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -6717,7 +6717,7 @@ for all Fortran versions. 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 not set, then $SHF08PPCOM or $SHFORTRANPPCOM +If not set, then &cv-link-SHF08PPCOM; or &cv-link-SHFORTRANPPCOM; (the command line) is displayed. @@ -6728,10 +6728,10 @@ If not set, then $SHF08PPCOM The Fortran 77 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the &cv-link-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 &cv-link-SHF77; if you need to use a specific compiler or compiler version for Fortran 77 files. @@ -6743,9 +6743,9 @@ or compiler version for Fortran 77 files. 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 &cv-link-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 &cv-link-SHFORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -6758,7 +6758,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 77 source file is compiled to a shared-library object file. -If not set, then $SHF77COM or $SHFORTRANCOM +If not set, then &cv-link-SHF77COM; or &cv-link-SHFORTRANCOM; (the command line) is displayed. @@ -6770,9 +6770,9 @@ If not set, then $SHF77COM or 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 &cv-link-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 &cv-link-SHFORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6787,11 +6787,11 @@ for all Fortran versions. 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 &cv-link-SHF77FLAGS; and &cv-link-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 &cv-link-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 &cv-link-SHFORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -6805,7 +6805,7 @@ for all Fortran versions. 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 not set, then $SHF77PPCOM or $SHFORTRANPPCOM +If not set, then &cv-link-SHF77PPCOM; or &cv-link-SHFORTRANPPCOM; (the command line) is displayed. @@ -6816,10 +6816,10 @@ If not set, then $SHF77PPCOM The Fortran 90 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the &cv-link-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 &cv-link-SHF90; if you need to use a specific compiler or compiler version for Fortran 90 files. @@ -6831,9 +6831,9 @@ or compiler version for Fortran 90 files. 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 &cv-link-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 &cv-link-SHFORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -6846,7 +6846,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 90 source file is compiled to a shared-library object file. -If not set, then $SHF90COM or $SHFORTRANCOM +If not set, then &cv-link-SHF90COM; or &cv-link-SHFORTRANCOM; (the command line) is displayed. @@ -6858,9 +6858,9 @@ If not set, then $SHF90COM or 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 &cv-link-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 &cv-link-SHFORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6875,11 +6875,11 @@ for all Fortran versions. 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 &cv-link-SHF90FLAGS; and &cv-link-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 &cv-link-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 &cv-link-SHFORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -6893,7 +6893,7 @@ for all Fortran versions. 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 not set, then $SHF90PPCOM or $SHFORTRANPPCOM +If not set, then &cv-link-SHF90PPCOM; or &cv-link-SHFORTRANPPCOM; (the command line) is displayed. @@ -6904,10 +6904,10 @@ If not set, then $SHF90PPCOM The Fortran 95 compiler used for generating shared-library objects. -You should normally set the $SHFORTRAN variable, +You should normally set the &cv-link-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 &cv-link-SHF95; if you need to use a specific compiler or compiler version for Fortran 95 files. @@ -6919,9 +6919,9 @@ or compiler version for Fortran 95 files. 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 &cv-link-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 &cv-link-SHFORTRANCOM; variable, which specifies the default command line for all Fortran versions. @@ -6934,7 +6934,7 @@ for all Fortran versions. If set, the string displayed when a Fortran 95 source file is compiled to a shared-library object file. -If not set, then $SHF95COM or $SHFORTRANCOM +If not set, then &cv-link-SHF95COM; or &cv-link-SHFORTRANCOM; (the command line) is displayed. @@ -6946,9 +6946,9 @@ If not set, then $SHF95COM or 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 &cv-link-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 &cv-link-SHFORTRANFLAGS; variable, which specifies the user-specified options passed to the default Fortran compiler for all Fortran versions. @@ -6963,11 +6963,11 @@ for all Fortran versions. 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 &cv-link-SHF95FLAGS; and &cv-link-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 &cv-link-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 &cv-link-SHFORTRANPPCOM; variable, which specifies the default C-preprocessor command line for all Fortran versions. @@ -6981,7 +6981,7 @@ for all Fortran versions. 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 not set, then $SHF95PPCOM or $SHFORTRANPPCOM +If not set, then &cv-link-SHF95PPCOM; or &cv-link-SHFORTRANPPCOM; (the command line) is displayed. @@ -7012,7 +7012,7 @@ to a shared-library object file. If set, the string displayed when a Fortran source file is compiled to a shared-library object file. -If not set, then $SHFORTRANCOM +If not set, then &cv-link-SHFORTRANCOM; (the command line) is displayed. @@ -7036,8 +7036,8 @@ 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 &cv-link-SHFORTRANFLAGS; and +&cv-link-CPPFLAGS; construction variables are included on this command line. @@ -7050,7 +7050,7 @@ are included on this command line. 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 not set, then $SHFORTRANPPCOM +If not set, then &cv-link-SHFORTRANPPCOM; (the command line) is displayed. @@ -7061,7 +7061,7 @@ If not set, then $SHFORTRANPPCOM Contains the emitter specification for the -SharedLibrary builder. +&b-link-SharedLibrary; builder. The manpage section "Builder Objects" contains general information on specifying emitters. @@ -7072,7 +7072,7 @@ general information on specifying emitters. SHLIBNOVERSIONSYMLINKS -Instructs the SharedLibrary builder to not create symlinks for versioned +Instructs the &b-link-SharedLibrary; builder to not create symlinks for versioned shared libraries. @@ -7092,8 +7092,8 @@ The prefix used for shared library file names. 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 &b-link-SharedLibrary; builder when +the linker tool supports SONAME (e.g. &t-link-gnulink;). @@ -7112,12 +7112,12 @@ The suffix used for shared library file names. 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 &b-link-SharedLibrary; builder. This activates the +&cv-link-_SHLIBVERSIONFLAGS; and thus modifies the &cv-link-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. &cv-link-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 &cv-link-SHLIBVERSION; values include '1', '1.2.3', and '1.2.gitaa412c8b'. @@ -7126,9 +7126,9 @@ Example $SHLIBVERSION valu _SHLIBVERSIONFLAGS -This macro automatically introduces extra flags to $SHLINKCOM when -building versioned SharedLibrary (that is when $SHLIBVERSION -is set). _SHLIBVERSIONFLAGS usually adds $SHLIBVERSIONFLAGS +This macro automatically introduces extra flags to &cv-link-SHLINKCOM; when +building versioned &b-link-SharedLibrary; (that is when &cv-link-SHLIBVERSION; +is set). _SHLIBVERSIONFLAGS usually adds &cv-link-SHLIBVERSIONFLAGS; and some extra dynamically generated options (such as -Wl,-soname=$_SHLIBSONAME. It is unused by "plain" (unversioned) shared libraries. @@ -7140,8 +7140,8 @@ 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 +Extra flags added to &cv-link-SHLINKCOM; when building versioned +&b-link-SharedLibrary;. These flags are only used when &cv-link-SHLIBVERSION; is set. @@ -7152,7 +7152,7 @@ set. The linker for programs that use shared libraries. -See also $LINK for linking static objects. +See also &cv-link-LINK; for linking static objects. @@ -7162,7 +7162,7 @@ See also $LINK for linking static The command line used to link programs using shared libraries. -See also $LINKCOM for linking static objects. +See also &cv-link-LINKCOM; for linking static objects. @@ -7172,8 +7172,8 @@ See also $LINKCOM for linking s The string displayed when programs using shared libraries are linked. -If this is not set, then $SHLINKCOM (the command line) is displayed. -See also $LINKCOMSTR for linking static objects. +If this is not set, then &cv-link-SHLINKCOM; (the command line) is displayed. +See also &cv-link-LINKCOMSTR; for linking static objects. @@ -7191,20 +7191,20 @@ 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 &cv-link-LIBS;, nor (or similar) include search path options -that scons generates automatically from $LIBPATH. +that scons generates automatically from &cv-link-LIBPATH;. See -$_LIBFLAGS +&cv-link-_LIBFLAGS; above, for the variable that expands to library-link options, and -$_LIBDIRFLAGS +&cv-link-_LIBDIRFLAGS; above, for the variable that expands to library search path options. -See also $LINKFLAGS for linking static objects. +See also &cv-link-LINKFLAGS; for linking static objects. @@ -7235,7 +7235,7 @@ 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 &t-link-gnulink; linker tool. @@ -7320,7 +7320,7 @@ in which the command should be executed. SUBST_DICT -The dictionary used by the Substfile or Textfile builders +The dictionary used by the &b-Substfile; or &b-Textfile; builders for substitution values. It can be anything acceptable to the dict() constructor, so in addition to a dictionary, @@ -7333,7 +7333,7 @@ lists of tuples are also acceptable. SUBSTFILEPREFIX -The prefix used for Substfile file names, +The prefix used for &b-Substfile; file names, an empty string by default. @@ -7343,7 +7343,7 @@ an empty string by default. SUBSTFILESUFFIX -The suffix used for Substfile file names, +The suffix used for &b-Substfile; file names, an empty string by default. @@ -7381,13 +7381,13 @@ 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&cv-link-CFILESUFFIX;. By default, this value is used whenever the option is not specified as part of the -$SWIGFLAGS +&cv-link-SWIGFLAGS; construction variable. @@ -7409,7 +7409,7 @@ the scripting language wrapper and interface generator. 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 &cv-link-SWIGCOM; (the command line) is displayed. @@ -7422,11 +7422,11 @@ 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&cv-link-CFILESUFFIX;. By default, this value is used whenever the -c++ option is specified as part of the -$SWIGFLAGS +&cv-link-SWIGFLAGS; construction variable. @@ -7460,11 +7460,11 @@ 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 +&cv-link-CXXFILESUFFIX; variable. @@ -7477,11 +7477,11 @@ variable. 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 &cv-_SWIGINCFLAGS; is created by respectively prepending and appending -$SWIGINCPREFIX and $SWIGINCSUFFIX +&cv-SWIGINCPREFIX; and &cv-SWIGINCSUFFIX; to the beginning and end -of each directory in $SWIGPATH. +of each directory in &cv-SWIGPATH;. @@ -7492,8 +7492,8 @@ of each directory in $SWIGPATH. 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 &cv-SWIGPATH; construction variable +when the &cv-_SWIGINCFLAGS; variable is automatically generated. @@ -7504,8 +7504,8 @@ when the $_SWIGINCFLAGS variable is automatically generated. 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 &cv-SWIGPATH; construction variable +when the &cv-_SWIGINCFLAGS; variable is automatically generated. @@ -7518,7 +7518,7 @@ 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. @@ -7543,7 +7543,7 @@ 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 #: @@ -7553,7 +7553,7 @@ env = Environment(SWIGPATH='#/include') The directory look-up can also be forced using the -Dir() +&Dir;() function: @@ -7565,17 +7565,17 @@ env = Environment(SWIGPATH=include) The directory list will be added to command lines through the automatically-generated -$_SWIGINCFLAGS +&cv-_SWIGINCFLAGS; construction variable, which is constructed by respectively prepending and appending the values of the -$SWIGINCPREFIX and $SWIGINCSUFFIX +&cv-SWIGINCPREFIX; and &cv-SWIGINCSUFFIX; construction variables to the beginning and end -of each directory in $SWIGPATH. +of each directory in &cv-SWIGPATH;. Any command lines you define that need the SWIGPATH directory list should -include $_SWIGINCFLAGS: +include &cv-_SWIGINCFLAGS;: @@ -7617,7 +7617,7 @@ The command line used to call the tar archiver. 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 &cv-link-TARCOM; (the command line) is displayed. @@ -7653,7 +7653,7 @@ for more information). 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 +&cv-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() @@ -7727,7 +7727,7 @@ 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. +The string (or character) to be used to join the arguments passed to TEMPFILE when command line exceeds the limit set by &cv-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. @@ -7789,7 +7789,7 @@ The command line used to call the TeX formatter and typesetter. 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 &cv-link-TEXCOM; (the command line) is displayed. @@ -7823,7 +7823,7 @@ directories for \include and \import files. TEXTFILEPREFIX -The prefix used for Textfile file names, +The prefix used for &b-Textfile; file names, an empty string by default. @@ -7833,7 +7833,7 @@ an empty string by default. TEXTFILESUFFIX -The suffix used for Textfile file names; +The suffix used for &b-Textfile; file names; .txt by default. @@ -7924,16 +7924,16 @@ located. - Note that VSWHERE must be set at the same time or prior to any of msvc, msvs , and/or mslink Tool being initialized. + Note that VSWHERE must be set at the same time or prior to any of &t-link-msvc;, &t-link-msvs; , and/or &t-link-mslink; &f-link-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 if your &consenv; 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: +and also before &f-link-env-Tool; is called to ininitialize any of those tools: env = Environment(tools=[]) @@ -7951,7 +7951,7 @@ and also before env.Tool is c WIN32_INSERT_DEF -A deprecated synonym for $WINDOWS_INSERT_DEF. +A deprecated synonym for &cv-link-WINDOWS_INSERT_DEF;. @@ -7960,7 +7960,7 @@ A deprecated synonym for $WINDOWS_I WIN32DEFPREFIX -A deprecated synonym for $WINDOWSDEFPREFIX. +A deprecated synonym for &cv-link-WINDOWSDEFPREFIX;. @@ -7969,7 +7969,7 @@ A deprecated synonym for $WINDOWSDEFP WIN32DEFSUFFIX -A deprecated synonym for $WINDOWSDEFSUFFIX. +A deprecated synonym for &cv-link-WINDOWSDEFSUFFIX;. @@ -7978,7 +7978,7 @@ A deprecated synonym for $WINDOWSDEFS WIN32EXPPREFIX -A deprecated synonym for $WINDOWSEXPSUFFIX. +A deprecated synonym for &cv-link-WINDOWSEXPSUFFIX;. @@ -7987,7 +7987,7 @@ A deprecated synonym for $WINDOWSEXPS WIN32EXPSUFFIX -A deprecated synonym for $WINDOWSEXPSUFFIX. +A deprecated synonym for &cv-link-WINDOWSEXPSUFFIX;. @@ -8000,7 +8000,7 @@ 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 &cv-link-MT; and &cv-link-MTEXECOM; and &cv-link-MTSHLIBCOM;. @@ -8026,7 +8026,7 @@ The default is 0 (do not build a .def file). When this is set to true, -scons +&scons; will be aware of the .manifest files generated by Microsoft Visua C/C++ 8. @@ -8541,7 +8541,7 @@ field in the RPM Path to xgettext(1) program (found via Detect()). -See xgettext tool and POTUpdate builder. +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -8551,7 +8551,7 @@ See xgettext tool and Complete xgettext command line. -See xgettext tool and POTUpdate builder. +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -8561,8 +8561,8 @@ See xgettext tool and 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 &cv-link-XGETTEXTCOM;"). +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -8582,7 +8582,7 @@ form source and target (default: '${TARGET.filebase}'). Additional flags to xgettext(1). -See xgettext tool and POTUpdate builder. +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -8594,9 +8594,9 @@ See xgettext tool and 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 &cv-XGETTEXTFROM; files have same syntax and semantics as the well known GNU POTFILES.in. -See xgettext tool and POTUpdate builder. +See &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -8606,7 +8606,7 @@ See xgettext tool and Internal "macro". Genrates list of -D<dir> flags -from the $XGETTEXTPATH list. +from the &cv-link-XGETTEXTPATH; list. @@ -8615,7 +8615,7 @@ from the $XGETTEXTPATH lis XGETTEXTFROMPREFIX -This flag is used to add single $XGETTEXTFROM file to +This flag is used to add single &cv-link-XGETTEXTFROM; file to xgettext(1)'s commandline (default: '-f'). @@ -8638,9 +8638,9 @@ This flag is used to add single $XGETTEXT 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 &cv-link-XGETTEXTFROM; -See also xgettext tool and POTUpdate builder. +See also &t-link-xgettext; tool and &b-link-POTUpdate; builder. @@ -8650,7 +8650,7 @@ See also xgettext tool and Internal "macro". Generates list of -f<file> flags -from $XGETTEXTFROM. +from &cv-link-XGETTEXTFROM;. @@ -8700,7 +8700,7 @@ to generate a source file. 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 &cv-link-YACCCOM; (the command line) is displayed. @@ -8714,7 +8714,7 @@ env = Environment(YACCCOMSTR = "Yacc'ing $TARGET from $SOURCES") General options passed to the parser generator. -If $YACCFLAGS contains a option, +If &cv-link-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 @@ -8762,7 +8762,7 @@ 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. @@ -8837,7 +8837,7 @@ module is unavailable. The string displayed when archiving files using the zip utility. -If this is not set, then $ZIPCOM +If this is not set, then &cv-link-ZIPCOM; (the command line or internal Python function) is displayed. diff --git a/doc/user/sideeffect.xml b/doc/user/sideeffect.xml index 6a10c3b..d03fbe2 100644 --- a/doc/user/sideeffect.xml +++ b/doc/user/sideeffect.xml @@ -56,7 +56,7 @@ TODO: currently doesn't work due to issue #2154: - http://scons.tigris.org/issues/show_bug.cgi?id=2154 + https://github.com/SCons/scons/issues/2154 @@ -80,7 +80,7 @@ env = Environment() f2 = env.Command('file2', 'log', Copy('$TARGET', '$SOURCE')) f1 = env.Command('file1', [], - 'echo >$TARGET data1; echo >log updated file1')) + 'echo >$TARGET data1; echo >log updated file1') env.SideEffect('log', env.Command('file1', [], 'echo >$TARGET data1; echo >log updated file1')) -- cgit v0.12 From 1bae51f1d624072dc6b134bf990efa1e4baf1361 Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Sat, 20 Jun 2020 13:26:19 +0200 Subject: Added Sphinx support to the 'build' Docker images. --- CHANGES.txt | 2 ++ testing/docker/fedora32/build/Dockerfile | 2 +- testing/docker/ubuntu19.10/build/Dockerfile | 7 +------ 3 files changed, 4 insertions(+), 7 deletions(-) diff --git a/CHANGES.txt b/CHANGES.txt index d2ecca6..50c9387 100755 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -11,6 +11,8 @@ NOTE: Please include a reference to any Issues resolved by your changes in the b RELEASE VERSION/DATE TO BE FILLED IN LATER From Dirk Baechle: + - Updated documentation toolchain to work properly under Python3, also + removed libxslt support from the Docbook Tool. (issue #3580) - Added Docker images for building and testing SCons. (issue #3585) From James Benton: diff --git a/testing/docker/fedora32/build/Dockerfile b/testing/docker/fedora32/build/Dockerfile index 8d31d29..d4ef38d 100644 --- a/testing/docker/fedora32/build/Dockerfile +++ b/testing/docker/fedora32/build/Dockerfile @@ -4,7 +4,7 @@ FROM fedora:32 LABEL version="0.0.1" maintainer="Dirk Baechle " description="SCons Release Build, based on a Fedora 32" # Install additional packages -RUN dnf -y install git python3-lxml fop fontbox python3-devel lynx xterm vim vim-common nano unzip +RUN dnf -y install git python3-lxml binutils fop fontbox python3-devel python3-sphinx python3-sphinx_rtd_theme lynx xterm vim vim-common nano unzip # Install hyphenation patterns for FOP RUN mkdir /opt/offo && cd /opt/offo && curl -L --output offo-hyphenation-compiled.zip https://sourceforge.net/projects/offo/files/offo-hyphenation/2.2/offo-hyphenation-compiled.zip/download && unzip offo-hyphenation-compiled.zip && cp offo-hyphenation-compiled/fop-hyph.jar /usr/share/fop/ diff --git a/testing/docker/ubuntu19.10/build/Dockerfile b/testing/docker/ubuntu19.10/build/Dockerfile index 38f4dd7..06771de 100644 --- a/testing/docker/ubuntu19.10/build/Dockerfile +++ b/testing/docker/ubuntu19.10/build/Dockerfile @@ -4,14 +4,9 @@ FROM ubuntu:19.10 LABEL version="0.0.1" maintainer="Dirk Baechle " description="SCons Release Build, based on an Ubuntu 19.10" # Install additional packages -RUN apt-get update && apt-get -y install git python3-lxml fop libfontbox-java python3-dev rpm tar curl lynx xterm vim vim-common nano sudo +RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get -y install binutils git python3-lxml fop libfontbox-java python3-dev python3-sphinx python3-sphinx-rtd-theme rpm tar curl lynx xterm vim vim-common nano sudo # Install hyphenation patterns for FOP RUN mkdir /opt/offo && cd /opt/offo && curl -L --output offo-hyphenation-compiled.zip https://sourceforge.net/projects/offo/files/offo-hyphenation/2.2/offo-hyphenation-compiled.zip/download && unzip offo-hyphenation-compiled.zip && cp offo-hyphenation-compiled/fop-hyph.jar /usr/share/fop/ -# Epydoc can be installed via pip3, but it doesn't seem to work properly. -# For the moment we don't install it and might replace it with Sphinx later... -# RUN apt-get -y install python3-pip && pip3 install epydoc - CMD ["/bin/bash"] - -- cgit v0.12 From dcd51ed7832daf0151596cf103e3c33ca16e5360 Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Sun, 21 Jun 2020 00:31:32 +0200 Subject: Replaced 'bare excepts', now catching Exception. --- SCons/Tool/docbook/__init__.py | 14 ++++++++------ bin/SConsDoc.py | 6 ------ 2 files changed, 8 insertions(+), 12 deletions(-) diff --git a/SCons/Tool/docbook/__init__.py b/SCons/Tool/docbook/__init__.py index c3a4610..504c853 100644 --- a/SCons/Tool/docbook/__init__.py +++ b/SCons/Tool/docbook/__init__.py @@ -55,7 +55,7 @@ db_xsl_folder = 'docbook-xsl-1.76.1' has_lxml = True try: import lxml -except: +except Exception: has_lxml = False # Set this to True, to prefer xsltproc over lxml @@ -301,8 +301,9 @@ def __build_lxml(target, source, env): try: with open(str(target[0]), "wb") as of: of.write(etree.tostring(result, encoding="utf-8", pretty_print=True)) - except: - pass + except Exception as e: + print("ERROR: Failed to write {}".format(str(target[0]))) + print(e) return None @@ -342,8 +343,9 @@ def __xinclude_lxml(target, source, env): try: doc.write(str(target[0]), xml_declaration=True, encoding="UTF-8", pretty_print=True) - except: - pass + except Exception as e: + print("ERROR: Failed to write {}".format(str(target[0]))) + print(e) return None @@ -627,7 +629,7 @@ def DocbookMan(env, target, source=None, *args, **kw): for ref in node.getElementsByTagName('refname'): outfiles.append(__get_xml_text(ref)+'.'+volnum) - except: + except Exception: # Use simple regex parsing with open(__ensure_suffix(str(s),'.xml'), 'r') as f: content = f.read() diff --git a/bin/SConsDoc.py b/bin/SConsDoc.py index d0c79ae..a2daa55 100644 --- a/bin/SConsDoc.py +++ b/bin/SConsDoc.py @@ -117,12 +117,6 @@ import sys import copy import importlib -# Do we have lxml? -try: - import lxml -except ImportError: - raise ImportError("Failed to import lxml") - try: from lxml import etree except ImportError: -- cgit v0.12 From 917afa48a975454fc8280176a729df38ebcde02d Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Sun, 21 Jun 2020 15:53:50 +0200 Subject: Fixed Docbook Tool and updated its tests. --- SCons/Tool/docbook/__init__.py | 19 +- SCons/Tool/docbook/__init__.xml | 4 +- doc/SConscript | 2 +- test/Docbook/basedir/htmlchunked/htmlchunked.py | 10 +- .../Docbook/basedir/htmlchunked/htmlchunked_cmd.py | 2 +- test/Docbook/basedir/htmlhelp/htmlhelp.py | 14 +- test/Docbook/basedir/htmlhelp/htmlhelp_cmd.py | 6 +- .../basedir/slideshtml/image/SConstruct.cmd | 1 + test/Docbook/basedir/slideshtml/image/virt.xml | 2 +- test/Docbook/basedir/slideshtml/slideshtml.py | 19 +- test/Docbook/basedir/slideshtml/slideshtml_cmd.py | 13 +- test/Docbook/basic/epub/epub.py | 16 +- test/Docbook/basic/epub/epub_cmd.py | 8 +- test/Docbook/basic/html/html.py | 10 +- test/Docbook/basic/html/html_cmd.py | 2 +- test/Docbook/basic/htmlchunked/htmlchunked.py | 10 +- test/Docbook/basic/htmlchunked/htmlchunked_cmd.py | 2 +- test/Docbook/basic/htmlhelp/htmlhelp.py | 14 +- test/Docbook/basic/htmlhelp/htmlhelp_cmd.py | 6 +- test/Docbook/basic/man/man.py | 12 +- test/Docbook/basic/man/man_cmd.py | 4 +- test/Docbook/basic/pdf/image/SConstruct | 3 + test/Docbook/basic/pdf/image/SConstruct.cmd | 7 + test/Docbook/basic/pdf/image/manual.xml | 388 +++++++++++++++++++++ test/Docbook/basic/pdf/pdf.py | 60 ++++ test/Docbook/basic/pdf/pdf_cmd.py | 60 ++++ test/Docbook/basic/slideshtml/image/SConstruct.cmd | 1 + test/Docbook/basic/slideshtml/image/virt.xml | 2 +- test/Docbook/basic/slideshtml/slideshtml.py | 19 +- test/Docbook/basic/slideshtml/slideshtml_cmd.py | 13 +- test/Docbook/basic/slidespdf/image/SConstruct | 3 + test/Docbook/basic/slidespdf/image/SConstruct.cmd | 4 + test/Docbook/basic/slidespdf/image/virt.xml | 33 ++ test/Docbook/basic/slidespdf/slidespdf.py | 66 ++++ test/Docbook/basic/slidespdf/slidespdf_cmd.py | 63 ++++ test/Docbook/basic/xinclude/xinclude.py | 10 +- test/Docbook/basic/xslt/image/SConstruct | 9 + test/Docbook/basic/xslt/image/in.xml | 77 ++++ test/Docbook/basic/xslt/image/to_docbook.xslt | 102 ++++++ test/Docbook/basic/xslt/xslt.py | 57 +++ test/Docbook/dependencies/xinclude/xinclude.py | 12 +- test/Docbook/rootname/htmlchunked/htmlchunked.py | 10 +- test/Docbook/rootname/htmlhelp/htmlhelp.py | 14 +- test/Docbook/rootname/slideshtml/image/virt.xml | 2 +- test/Docbook/rootname/slideshtml/slideshtml.py | 19 +- testing/framework/TestCommon.py | 19 + testing/framework/TestCommonTests.py | 52 +++ 47 files changed, 1113 insertions(+), 168 deletions(-) create mode 100644 test/Docbook/basic/pdf/image/SConstruct create mode 100644 test/Docbook/basic/pdf/image/SConstruct.cmd create mode 100644 test/Docbook/basic/pdf/image/manual.xml create mode 100644 test/Docbook/basic/pdf/pdf.py create mode 100644 test/Docbook/basic/pdf/pdf_cmd.py create mode 100644 test/Docbook/basic/slidespdf/image/SConstruct create mode 100644 test/Docbook/basic/slidespdf/image/SConstruct.cmd create mode 100644 test/Docbook/basic/slidespdf/image/virt.xml create mode 100644 test/Docbook/basic/slidespdf/slidespdf.py create mode 100644 test/Docbook/basic/slidespdf/slidespdf_cmd.py create mode 100644 test/Docbook/basic/xslt/image/SConstruct create mode 100644 test/Docbook/basic/xslt/image/in.xml create mode 100644 test/Docbook/basic/xslt/image/to_docbook.xslt create mode 100644 test/Docbook/basic/xslt/xslt.py diff --git a/SCons/Tool/docbook/__init__.py b/SCons/Tool/docbook/__init__.py index 504c853..c5261a2 100644 --- a/SCons/Tool/docbook/__init__.py +++ b/SCons/Tool/docbook/__init__.py @@ -307,9 +307,10 @@ def __build_lxml(target, source, env): return None -def __build_lxml_manpage(target, source, env): +def __build_lxml_noresult(target, source, env): """ - Specialized XSLT builder for manpages, using the lxml module. + Specialized XSLT builder for transformations without a direct result where the Docbook + stylesheet itself creates the target file, using the lxml module. """ from lxml import etree @@ -355,8 +356,8 @@ __lxml_builder = SCons.Builder.Builder( source_scanner = docbook_xml_scanner, emitter = __emit_xsl_basedir) -__lxml_manpage_builder = SCons.Builder.Builder( - action = __build_lxml_manpage, +__lxml_noresult_builder = SCons.Builder.Builder( + action = __build_lxml_noresult, src_suffix = '.xml', source_scanner = docbook_xml_scanner, emitter = __emit_xsl_basedir) @@ -449,7 +450,7 @@ def DocbookEpub(env, target, source=None, *args, **kw): __init_xsl_stylesheet(kw, env, '$DOCBOOK_DEFAULT_XSL_EPUB', ['epub','docbook.xsl']) # Setup builder - __builder = __select_builder(__lxml_builder, __xsltproc_builder) + __builder = __select_builder(__lxml_noresult_builder, __xsltproc_builder) # Create targets result = [] @@ -518,7 +519,7 @@ def DocbookHtmlChunked(env, target, source=None, *args, **kw): __init_xsl_stylesheet(kw, env, '$DOCBOOK_DEFAULT_XSL_HTMLCHUNKED', ['html','chunkfast.xsl']) # Setup builder - __builder = __select_builder(__lxml_builder, __xsltproc_builder) + __builder = __select_builder(__lxml_noresult_builder, __xsltproc_builder) # Detect base dir base_dir = kw.get('base_dir', '') @@ -553,7 +554,7 @@ def DocbookHtmlhelp(env, target, source=None, *args, **kw): __init_xsl_stylesheet(kw, env, '$DOCBOOK_DEFAULT_XSL_HTMLHELP', ['htmlhelp','htmlhelp.xsl']) # Setup builder - __builder = __select_builder(__lxml_builder, __xsltproc_builder) + __builder = __select_builder(__lxml_noresult_builder, __xsltproc_builder) # Detect base dir base_dir = kw.get('base_dir', '') @@ -606,7 +607,7 @@ def DocbookMan(env, target, source=None, *args, **kw): __init_xsl_stylesheet(kw, env, '$DOCBOOK_DEFAULT_XSL_MAN', ['manpages','docbook.xsl']) # Setup builder - __builder = __select_builder(__lxml_manpage_builder, __xsltproc_builder) + __builder = __select_builder(__lxml_noresult_builder, __xsltproc_builder) # Create targets result = [] @@ -702,7 +703,7 @@ def DocbookSlidesHtml(env, target, source=None, *args, **kw): __init_xsl_stylesheet(kw, env, '$DOCBOOK_DEFAULT_XSL_SLIDESHTML', ['slides','html','plain.xsl']) # Setup builder - __builder = __select_builder(__lxml_builder, __xsltproc_builder) + __builder = __select_builder(__lxml_noresult_builder, __xsltproc_builder) # Detect base dir base_dir = kw.get('base_dir', '') diff --git a/SCons/Tool/docbook/__init__.xml b/SCons/Tool/docbook/__init__.xml index 0835440..4c079b7 100644 --- a/SCons/Tool/docbook/__init__.xml +++ b/SCons/Tool/docbook/__init__.xml @@ -254,7 +254,7 @@ The path to the external executable xsltproc (or saxon, xalan), if one of them is installed. Note, that this is only used as last fallback for XSL transformations, if -no libxml2 or lxml Python binding can be imported in the current system. +no lxml Python binding can be imported in the current system. @@ -264,7 +264,7 @@ no libxml2 or lxml Python binding can be imported in the current system. 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 +XIncludes, if no lxml Python binding can be imported in the current system. diff --git a/doc/SConscript b/doc/SConscript index 4ab4200..46fb5ff 100644 --- a/doc/SConscript +++ b/doc/SConscript @@ -44,7 +44,7 @@ try: except ImportError as exc: print("doc: SConsDoc failed to import, the error was:") print(" ImportError: %s" % exc) - print(" Please make sure that python-libxml2 or python-lxml is installed.") + print(" Please make sure that python-lxml is installed.") skip_doc = True fop = whereis('fop') diff --git a/test/Docbook/basedir/htmlchunked/htmlchunked.py b/test/Docbook/basedir/htmlchunked/htmlchunked.py index f97555b..893761c 100644 --- a/test/Docbook/basedir/htmlchunked/htmlchunked.py +++ b/test/Docbook/basedir/htmlchunked/htmlchunked.py @@ -37,19 +37,15 @@ if not (sys.platform.startswith('linux') and test.skip_test('Wrong OS or no stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('output/index.html')) +test.must_not_be_empty(test.workpath('output/index.html')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basedir/htmlchunked/htmlchunked_cmd.py b/test/Docbook/basedir/htmlchunked/htmlchunked_cmd.py index b507eb1..3ad6369 100644 --- a/test/Docbook/basedir/htmlchunked/htmlchunked_cmd.py +++ b/test/Docbook/basedir/htmlchunked/htmlchunked_cmd.py @@ -42,7 +42,7 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd'], stderr=None) -test.must_exist(test.workpath('output/index.html')) +test.must_not_be_empty(test.workpath('output/index.html')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c']) diff --git a/test/Docbook/basedir/htmlhelp/htmlhelp.py b/test/Docbook/basedir/htmlhelp/htmlhelp.py index 17aba09..7fbc875 100644 --- a/test/Docbook/basedir/htmlhelp/htmlhelp.py +++ b/test/Docbook/basedir/htmlhelp/htmlhelp.py @@ -37,21 +37,17 @@ if not (sys.platform.startswith('linux') and test.skip_test('Wrong OS or no stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('output/index.html')) -test.must_exist(test.workpath('htmlhelp.hhp')) -test.must_exist(test.workpath('toc.hhc')) +test.must_not_be_empty(test.workpath('output/index.html')) +test.must_not_be_empty(test.workpath('htmlhelp.hhp')) +test.must_not_be_empty(test.workpath('toc.hhc')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basedir/htmlhelp/htmlhelp_cmd.py b/test/Docbook/basedir/htmlhelp/htmlhelp_cmd.py index a0f5e8a..2b004c6 100644 --- a/test/Docbook/basedir/htmlhelp/htmlhelp_cmd.py +++ b/test/Docbook/basedir/htmlhelp/htmlhelp_cmd.py @@ -42,9 +42,9 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd'], stderr=None) -test.must_exist(test.workpath('output/index.html')) -test.must_exist(test.workpath('htmlhelp.hhp')) -test.must_exist(test.workpath('toc.hhc')) +test.must_not_be_empty(test.workpath('output/index.html')) +test.must_not_be_empty(test.workpath('htmlhelp.hhp')) +test.must_not_be_empty(test.workpath('toc.hhc')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c']) diff --git a/test/Docbook/basedir/slideshtml/image/SConstruct.cmd b/test/Docbook/basedir/slideshtml/image/SConstruct.cmd index 297aeb5..d5b73f9 100644 --- a/test/Docbook/basedir/slideshtml/image/SConstruct.cmd +++ b/test/Docbook/basedir/slideshtml/image/SConstruct.cmd @@ -1,3 +1,4 @@ env = Environment(DOCBOOK_PREFER_XSLTPROC=1, tools=['docbook']) +env.Append(DOCBOOK_XSLTPROCFLAGS=['--novalid', '--nonet']) env.DocbookSlidesHtml('virt', xsl='slides.xsl', base_dir='output/') diff --git a/test/Docbook/basedir/slideshtml/image/virt.xml b/test/Docbook/basedir/slideshtml/image/virt.xml index aec1fd7..9cdf778 100644 --- a/test/Docbook/basedir/slideshtml/image/virt.xml +++ b/test/Docbook/basedir/slideshtml/image/virt.xml @@ -1,6 +1,6 @@ +"http://docbook.sourceforge.net/release/slides/3.3.1/schema/dtd/slides.dtd"> Virtuelles Kopieren diff --git a/test/Docbook/basedir/slideshtml/slideshtml.py b/test/Docbook/basedir/slideshtml/slideshtml.py index a89edcd..de3cd83 100644 --- a/test/Docbook/basedir/slideshtml/slideshtml.py +++ b/test/Docbook/basedir/slideshtml/slideshtml.py @@ -33,27 +33,22 @@ import TestSCons test = TestSCons.TestSCons() if not (sys.platform.startswith('linux') and - os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides') and - os.path.isdir('/usr/share/xml/docbook/custom/slides/3.3.1')): + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): test.skip_test('Wrong OS or no "slides" stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('output/index.html')) -test.must_exist(test.workpath('output/toc.html')) -test.must_exist(test.workpath('output/foil01.html')) -test.must_exist(test.workpath('output/foilgroup01.html')) +test.must_not_be_empty(test.workpath('output/index.html')) +test.must_not_be_empty(test.workpath('output/toc.html')) +test.must_not_be_empty(test.workpath('output/foil01.html')) +test.must_not_be_empty(test.workpath('output/foilgroup01.html')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basedir/slideshtml/slideshtml_cmd.py b/test/Docbook/basedir/slideshtml/slideshtml_cmd.py index 51ed6e4..5d2556d 100644 --- a/test/Docbook/basedir/slideshtml/slideshtml_cmd.py +++ b/test/Docbook/basedir/slideshtml/slideshtml_cmd.py @@ -35,21 +35,20 @@ test = TestSCons.TestSCons() xsltproc = test.where_is('xsltproc') if not (xsltproc and - os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides') and - os.path.isdir('/usr/share/xml/docbook/custom/slides/3.3.1')): + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): test.skip_test('No xsltproc or no "slides" stylesheets installed, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd'], stderr=None) -test.must_exist(test.workpath('output/index.html')) -test.must_exist(test.workpath('output/toc.html')) -test.must_exist(test.workpath('output/foil01.html')) -test.must_exist(test.workpath('output/foilgroup01.html')) +test.must_not_be_empty(test.workpath('output/index.html')) +test.must_not_be_empty(test.workpath('output/toc.html')) +test.must_not_be_empty(test.workpath('output/foil01.html')) +test.must_not_be_empty(test.workpath('output/foilgroup01.html')) # Cleanup -test.run(arguments=['-f','SConstruct.cmd','-c']) +test.run(arguments=['-f','SConstruct.cmd','-c'], stderr=None) test.must_not_exist(test.workpath('output/index.html')) test.must_not_exist(test.workpath('output/toc.html')) test.must_not_exist(test.workpath('output/foil01.html')) diff --git a/test/Docbook/basic/epub/epub.py b/test/Docbook/basic/epub/epub.py index 0a317b6..e2b37a1 100644 --- a/test/Docbook/basic/epub/epub.py +++ b/test/Docbook/basic/epub/epub.py @@ -31,22 +31,18 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('manual.epub')) -test.must_exist(test.workpath('OEBPS','toc.ncx')) -test.must_exist(test.workpath('OEBPS','content.opf')) -test.must_exist(test.workpath('META-INF','container.xml')) +test.must_not_be_empty(test.workpath('manual.epub')) +test.must_not_be_empty(test.workpath('OEBPS','toc.ncx')) +test.must_not_be_empty(test.workpath('OEBPS','content.opf')) +test.must_not_be_empty(test.workpath('META-INF','container.xml')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basic/epub/epub_cmd.py b/test/Docbook/basic/epub/epub_cmd.py index 285d940..e8affe2 100644 --- a/test/Docbook/basic/epub/epub_cmd.py +++ b/test/Docbook/basic/epub/epub_cmd.py @@ -38,10 +38,10 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd','DOCBOOK_XSLTPROC=%s'%xsltproc], stderr=None) -test.must_exist(test.workpath('manual.epub')) -test.must_exist(test.workpath('OEBPS','toc.ncx')) -test.must_exist(test.workpath('OEBPS','content.opf')) -test.must_exist(test.workpath('META-INF','container.xml')) +test.must_not_be_empty(test.workpath('manual.epub')) +test.must_not_be_empty(test.workpath('OEBPS','toc.ncx')) +test.must_not_be_empty(test.workpath('OEBPS','content.opf')) +test.must_not_be_empty(test.workpath('META-INF','container.xml')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c','DOCBOOK_XSLTPROC=%s'%xsltproc]) diff --git a/test/Docbook/basic/html/html.py b/test/Docbook/basic/html/html.py index acf38a3..d6a3114 100644 --- a/test/Docbook/basic/html/html.py +++ b/test/Docbook/basic/html/html.py @@ -31,19 +31,15 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run() -test.must_exist(test.workpath('manual.html')) +test.must_not_be_empty(test.workpath('manual.html')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basic/html/html_cmd.py b/test/Docbook/basic/html/html_cmd.py index cfc71b0..122d8bc 100644 --- a/test/Docbook/basic/html/html_cmd.py +++ b/test/Docbook/basic/html/html_cmd.py @@ -39,7 +39,7 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd','DOCBOOK_XSLTPROC=%s'%xsltproc]) -test.must_exist(test.workpath('manual.html')) +test.must_not_be_empty(test.workpath('manual.html')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c','DOCBOOK_XSLTPROC=%s'%xsltproc]) diff --git a/test/Docbook/basic/htmlchunked/htmlchunked.py b/test/Docbook/basic/htmlchunked/htmlchunked.py index 74b8c7a..71f6265 100644 --- a/test/Docbook/basic/htmlchunked/htmlchunked.py +++ b/test/Docbook/basic/htmlchunked/htmlchunked.py @@ -31,19 +31,15 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('index.html')) +test.must_not_be_empty(test.workpath('index.html')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basic/htmlchunked/htmlchunked_cmd.py b/test/Docbook/basic/htmlchunked/htmlchunked_cmd.py index b194b70..6b79102 100644 --- a/test/Docbook/basic/htmlchunked/htmlchunked_cmd.py +++ b/test/Docbook/basic/htmlchunked/htmlchunked_cmd.py @@ -40,7 +40,7 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd','DOCBOOK_XSLTPROC=%s'%xsltproc], stderr=None) -test.must_exist(test.workpath('index.html')) +test.must_not_be_empty(test.workpath('index.html')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c','DOCBOOK_XSLTPROC=%s'%xsltproc]) diff --git a/test/Docbook/basic/htmlhelp/htmlhelp.py b/test/Docbook/basic/htmlhelp/htmlhelp.py index 080ec60..37c4879 100644 --- a/test/Docbook/basic/htmlhelp/htmlhelp.py +++ b/test/Docbook/basic/htmlhelp/htmlhelp.py @@ -31,21 +31,17 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('index.html')) -test.must_exist(test.workpath('htmlhelp.hhp')) -test.must_exist(test.workpath('toc.hhc')) +test.must_not_be_empty(test.workpath('index.html')) +test.must_not_be_empty(test.workpath('htmlhelp.hhp')) +test.must_not_be_empty(test.workpath('toc.hhc')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basic/htmlhelp/htmlhelp_cmd.py b/test/Docbook/basic/htmlhelp/htmlhelp_cmd.py index 541ef75..6d3fd10 100644 --- a/test/Docbook/basic/htmlhelp/htmlhelp_cmd.py +++ b/test/Docbook/basic/htmlhelp/htmlhelp_cmd.py @@ -39,9 +39,9 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd','DOCBOOK_XSLTPROC=%s'%xsltproc], stderr=None) -test.must_exist(test.workpath('index.html')) -test.must_exist(test.workpath('htmlhelp.hhp')) -test.must_exist(test.workpath('toc.hhc')) +test.must_not_be_empty(test.workpath('index.html')) +test.must_not_be_empty(test.workpath('htmlhelp.hhp')) +test.must_not_be_empty(test.workpath('toc.hhc')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c','DOCBOOK_XSLTPROC=%s'%xsltproc]) diff --git a/test/Docbook/basic/man/man.py b/test/Docbook/basic/man/man.py index d9b16b3..d8cd716 100644 --- a/test/Docbook/basic/man/man.py +++ b/test/Docbook/basic/man/man.py @@ -31,20 +31,16 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('refdb.8')) -test.must_exist(test.workpath('refdb.sh.8')) +test.must_not_be_empty(test.workpath('refdb.8')) +test.must_not_be_empty(test.workpath('refdb.sh.8')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basic/man/man_cmd.py b/test/Docbook/basic/man/man_cmd.py index ecfc9bd..88aebb8 100644 --- a/test/Docbook/basic/man/man_cmd.py +++ b/test/Docbook/basic/man/man_cmd.py @@ -39,8 +39,8 @@ test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd','DOCBOOK_XSLTPROC=%s'%xsltproc], stderr=None) -test.must_exist(test.workpath('refdb.8')) -test.must_exist(test.workpath('refdb.sh.8')) +test.must_not_be_empty(test.workpath('refdb.8')) +test.must_not_be_empty(test.workpath('refdb.sh.8')) # Cleanup test.run(arguments=['-f','SConstruct.cmd','-c','DOCBOOK_XSLTPROC=%s'%xsltproc]) diff --git a/test/Docbook/basic/pdf/image/SConstruct b/test/Docbook/basic/pdf/image/SConstruct new file mode 100644 index 0000000..01b2c7f --- /dev/null +++ b/test/Docbook/basic/pdf/image/SConstruct @@ -0,0 +1,3 @@ +env = Environment(tools=['docbook']) +env.DocbookPdf('manual') + diff --git a/test/Docbook/basic/pdf/image/SConstruct.cmd b/test/Docbook/basic/pdf/image/SConstruct.cmd new file mode 100644 index 0000000..db1ed18 --- /dev/null +++ b/test/Docbook/basic/pdf/image/SConstruct.cmd @@ -0,0 +1,7 @@ +env = Environment(DOCBOOK_PREFER_XSLTPROC=1, tools=['docbook']) +DOCBOOK_XSLTPROC = ARGUMENTS.get('DOCBOOK_XSLTPROC', "") +if DOCBOOK_XSLTPROC: + env['DOCBOOK_XSLTPROC'] = DOCBOOK_XSLTPROC + +env.DocbookPdf('manual') + diff --git a/test/Docbook/basic/pdf/image/manual.xml b/test/Docbook/basic/pdf/image/manual.xml new file mode 100644 index 0000000..067c76e --- /dev/null +++ b/test/Docbook/basic/pdf/image/manual.xml @@ -0,0 +1,388 @@ + + + +
+ The SCons qt4 tool + + + + Dirk Baechle + + + 2010-12-06 + + +
+ Basics + + This tool can be used to compile Qt projects, designed for versions + 4.x.y and higher. It is not usable for Qt3 and older versions, since some + of the helper tools (moc, uic) + behave different. + +
+ Install + + Installing it, requires you to copy (or, even better: checkout) + the contents of the package's qt4 folder to + + + + /path_to_your_project/site_scons/site_tools/qt4, + if you need the Qt4 Tool in one project only, or + + + + ~/.scons/site_scons/site_tools/qt4, + for a system-wide installation under your current login. + + + + For more infos about this, please refer to + + + + the SCons User's Guide, chap. 17.7 "Where to put your custom + Builders and Tools" and + + + + the SCons Tools Wiki page at https://github.com/SCons/scons/wiki/ToolsIndex. + + +
+ +
+ How to activate + + For activating the tool "qt4", you have to add its name to the + Environment constructor, like this + + env = Environment(tools=['default','qt4']) + + + On its startup, the Qt4 tool tries to read the variable + QT4DIR from the current Environment and + os.environ. If it is not set, the value of + QTDIR (in Environment/os.environ) + is used as a fallback. + + So, you either have to explicitly give the path of your Qt4 + installation to the Environment with + + env['QT4DIR'] = '/usr/local/Trolltech/Qt-4.2.3' + + + or set the QT4DIR as environment variable in + your shell. +
+ +
+ Requirements + + Under Linux, "qt4" uses the system tool + pkg-config for automatically setting the required + compile and link flags of the single Qt4 modules (like QtCore, + QtGui,...). This means that + + + + you should have pkg-config installed, + and + + + + you additionally have to set + PKG_CONFIG_PATH in your shell environment, such + that it points to $QT4DIR/lib/pkgconfig (or + $QT4DIR/lib for some older versions). + + + + Based on these two environment variables + (QT4DIR and PKG_CONFIG_PATH), the + "qt4" tool initializes all QT4_* construction + variables listed in the Reference manual. This happens when the tool is + "detected" during Environment construction. As a consequence, the setup + of the tool gets a two-stage process, if you want to override the values + provided by your current shell settings: + + # Stage 1: create plain environment +qtEnv = Environment() +# Set new vars +qtEnv['QT4DIR'] = '/usr/local/Trolltech/Qt-4.2.3 +qtEnv['ENV']['PKG_CONFIG_PATH'] = '/usr/local/Trolltech/Qt-4.2.3/lib/pkgconfig' +# Stage 2: add qt4 tool +qtEnv.Tool('qt4') + +
+
+ +
+ Suggested boilerplate + + Based on the requirements above, we suggest a simple ready-to-go + setup as follows: + + SConstruct + + # Detect Qt version +qtdir = detectLatestQtDir() + +# Create base environment +baseEnv = Environment() +#...further customization of base env + +# Clone Qt environment +qtEnv = baseEnv.Clone() +# Set QT4DIR and PKG_CONFIG_PATH +qtEnv['ENV']['PKG_CONFIG_PATH'] = os.path.join(qtdir, 'lib/pkgconfig') +qtEnv['QT4DIR'] = qtdir +# Add qt4 tool +qtEnv.Tool('qt4') +#...further customization of qt env + +# Export environments +Export('baseEnv qtEnv') + +# Your other stuff... +# ...including the call to your SConscripts + + + In a SConscript + + # Get the Qt4 environment +Import('qtEnv') +# Clone it +env = qtEnv.clone() +# Patch it +env.Append(CCFLAGS=['-m32']) # or whatever +# Use it +env.StaticLibrary('foo', Glob('*.cpp')) + + + The detection of the Qt directory could be as simple as directly + assigning a fixed path + + def detectLatestQtDir(): + return "/usr/local/qt4.3.2" + + + or a little more sophisticated + + # Tries to detect the path to the installation of Qt with +# the highest version number +def detectLatestQtDir(): + if sys.platform.startswith("linux"): + # Simple check: inspect only '/usr/local/Trolltech' + paths = glob.glob('/usr/local/Trolltech/*') + if len(paths): + paths.sort() + return paths[-1] + else: + return "" + else: + # Simple check: inspect only 'C:\Qt' + paths = glob.glob('C:\\Qt\\*') + if len(paths): + paths.sort() + return paths[-1] + else: + return os.environ.get("QTDIR","") + +
+ +
+ A first project + + The following SConscript is for a simple project with some cxx + files, using the QtCore, QtGui and QtNetwork modules: + + Import('qtEnv') +env = qtEnv.Clone() +env.EnableQt4Modules([ + 'QtGui', + 'QtCore', + 'QtNetwork' + ]) +# Add your CCFLAGS and CPPPATHs to env here... + +env.Program('foo', Glob('*.cpp')) + +
+ +
+ MOC it up + + For the basic support of automocing, nothing needs to be done by the + user. The tool usually detects the Q_OBJECT macro and + calls the moc executable + accordingly. + + If you don't want this, you can switch off the automocing by + a + + env['QT4_AUTOSCAN'] = 0 + + + in your SConscript file. Then, you have to moc your files + explicitly, using the Moc4 builder. + + You can also switch to an extended automoc strategy with + + env['QT4_AUTOSCAN_STRATEGY'] = 1 + + + Please read the description of the + QT4_AUTOSCAN_STRATEGY variable in the Reference manual + for details. + + For debugging purposes, you can set the variable + QT4_DEBUG with + + env['QT4_DEBUG'] = 1 + + + which outputs a lot of messages during automocing. +
+ +
+ Forms (.ui) + + The header files with setup code for your GUI classes, are not + compiled automatically from your .ui files. You always + have to call the Uic4 builder explicitly like + + env.Uic4(Glob('*.ui')) +env.Program('foo', Glob('*.cpp')) + +
+ +
+ Resource files (.qrc) + + Resource files are not built automatically, you always have to add + the names of the .qrc files to the source list for your + program or library: + + env.Program('foo', Glob('*.cpp')+Glob('*.qrc')) + + + For each of the Resource input files, its prefix defines the name of + the resulting resource. An appropriate + -name option is added to the call of the + rcc executable by default. + + You can also call the Qrc4 builder explicitly as + + qrccc = env.Qrc4('foo') # ['foo.qrc'] -> ['qrc_foo.cc'] + + + or (overriding the default suffix) + + qrccc = env.Qrc4('myprefix_foo.cxx','foo.qrc') # -> ['qrc_myprefix_foo.cxx'] + + + and then add the resulting cxx file to the sources of your + Program/Library: + + env.Program('foo', Glob('*.cpp') + qrccc) + +
+ +
+ Translation files + + The update of the .ts files and the conversion to + binary .qm files is not done automatically. You have to + call the corresponding builders on your own. + + Example for updating a translation file: + + env.Ts4('foo.ts','.') # -> ['foo.ts'] + + + By default, the .ts files are treated as + precious targets. This means that they are not + removed prior to a rebuild, but simply get updated. Additionally, they do + not get cleaned on a scons -c. If you + want to delete the translation files on the + -c SCons command, you can set the + variable QT4_CLEAN_TS like this + + env['QT4_CLEAN_TS']=1 + + + Example for releasing a translation file, i.e. compiling it to a + .qm binary file: + + env.Qm4('foo') # ['foo.ts'] -> ['foo.qm'] + + + or (overriding the output prefix) + + env.Qm4('myprefix','foo') # ['foo.ts'] -> ['myprefix.qm'] + + + As an extension both, the Ts4() and Qm4 builder, support the + definition of multiple targets. So, calling + + env.Ts4(['app_en','app_de'], Glob('*.cpp')) + + + and + + env.Qm4(['app','copy'], Glob('*.ts')) + + + should work fine. + + Finally, two short notes about the support of directories for the + Ts4() builder. You can pass an arbitrary mix of cxx files and subdirs to + it, as in + + env.Ts4('app_en',['sub1','appwindow.cpp','main.cpp'])) + + + where sub1 is a folder that gets scanned + recursively for cxx files by lupdate. But like this, + you lose all dependency information for the subdir, i.e. if a file inside + the folder changes, the .ts file is not updated automatically! In this + case you should tell SCons to always update the target: + + ts = env.Ts4('app_en',['sub1','appwindow.cpp','main.cpp']) +env.AlwaysBuild(ts) + + + Last note: specifying the current folder + . as input to Ts4() and storing the + resulting .ts file in the same directory, leads to a dependency cycle! You + then have to store the .ts and .qm files outside of the current folder, or + use Glob('*.cpp')) instead. +
+
diff --git a/test/Docbook/basic/pdf/pdf.py b/test/Docbook/basic/pdf/pdf.py new file mode 100644 index 0000000..1268fde --- /dev/null +++ b/test/Docbook/basic/pdf/pdf.py @@ -0,0 +1,60 @@ +#!/usr/bin/env python +# +# Copyright (c) 2001-2010 The SCons Foundation +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +""" +Test the PDF builder. +""" + +import TestSCons + +test = TestSCons.TestSCons() + +fop = test.where_is('fop') +if not fop: + test.skip_test('No fop executable found, skipping test.\n') + +try: + import lxml +except: + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') + +test.dir_fixture('image') + +# Normal invocation +test.run(stderr=None) +test.must_not_be_empty(test.workpath('manual.fo')) +test.must_not_be_empty(test.workpath('manual.pdf')) + +# Cleanup +test.run(arguments='-c') +test.must_not_exist(test.workpath('manual.fo')) +test.must_not_exist(test.workpath('manual.pdf')) + +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: diff --git a/test/Docbook/basic/pdf/pdf_cmd.py b/test/Docbook/basic/pdf/pdf_cmd.py new file mode 100644 index 0000000..59dc4b3 --- /dev/null +++ b/test/Docbook/basic/pdf/pdf_cmd.py @@ -0,0 +1,60 @@ +#!/usr/bin/env python +# +# Copyright (c) 2001-2010 The SCons Foundation +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +""" +Test the PDF builder while using +the xsltproc executable, if it exists. +""" + +import TestSCons + +test = TestSCons.TestSCons() + +fop = test.where_is('fop') +if not fop: + test.skip_test('No fop executable found, skipping test.\n') + +xsltproc = test.where_is('xsltproc') +if not xsltproc: + test.skip_test('No xsltproc executable found, skipping test.\n') + +test.dir_fixture('image') + +# Normal invocation +test.run(arguments=['-f','SConstruct.cmd','DOCBOOK_XSLTPROC=%s'%xsltproc], stderr=None) +test.must_not_be_empty(test.workpath('manual.fo')) +test.must_not_be_empty(test.workpath('manual.pdf')) + +# Cleanup +test.run(arguments=['-f','SConstruct.cmd','-c','DOCBOOK_XSLTPROC=%s'%xsltproc]) +test.must_not_exist(test.workpath('manual.fo')) +test.must_not_exist(test.workpath('manual.pdf')) + +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: diff --git a/test/Docbook/basic/slideshtml/image/SConstruct.cmd b/test/Docbook/basic/slideshtml/image/SConstruct.cmd index 133cb11..ad5668c 100644 --- a/test/Docbook/basic/slideshtml/image/SConstruct.cmd +++ b/test/Docbook/basic/slideshtml/image/SConstruct.cmd @@ -1,3 +1,4 @@ env = Environment(DOCBOOK_PREFER_XSLTPROC=1, tools=['docbook']) +env.Append(DOCBOOK_XSLTPROCFLAGS=['--novalid', '--nonet']) env.DocbookSlidesHtml('virt') diff --git a/test/Docbook/basic/slideshtml/image/virt.xml b/test/Docbook/basic/slideshtml/image/virt.xml index aec1fd7..9cdf778 100644 --- a/test/Docbook/basic/slideshtml/image/virt.xml +++ b/test/Docbook/basic/slideshtml/image/virt.xml @@ -1,6 +1,6 @@ +"http://docbook.sourceforge.net/release/slides/3.3.1/schema/dtd/slides.dtd"> Virtuelles Kopieren diff --git a/test/Docbook/basic/slideshtml/slideshtml.py b/test/Docbook/basic/slideshtml/slideshtml.py index 8251b3e..ae9200f 100644 --- a/test/Docbook/basic/slideshtml/slideshtml.py +++ b/test/Docbook/basic/slideshtml/slideshtml.py @@ -33,27 +33,22 @@ import TestSCons test = TestSCons.TestSCons() if not (sys.platform.startswith('linux') and - os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides') and - os.path.isdir('/usr/share/xml/docbook/custom/slides/3.3.1')): + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): test.skip_test('Wrong OS or no "slides" stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('index.html')) -test.must_exist(test.workpath('toc.html')) -test.must_exist(test.workpath('foil01.html')) -test.must_exist(test.workpath('foilgroup01.html')) +test.must_not_be_empty(test.workpath('index.html')) +test.must_not_be_empty(test.workpath('toc.html')) +test.must_not_be_empty(test.workpath('foil01.html')) +test.must_not_be_empty(test.workpath('foilgroup01.html')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/basic/slideshtml/slideshtml_cmd.py b/test/Docbook/basic/slideshtml/slideshtml_cmd.py index ce5c30b..c51f831 100644 --- a/test/Docbook/basic/slideshtml/slideshtml_cmd.py +++ b/test/Docbook/basic/slideshtml/slideshtml_cmd.py @@ -35,21 +35,20 @@ test = TestSCons.TestSCons() xsltproc = test.where_is('xsltproc') if not (xsltproc and - os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides') and - os.path.isdir('/usr/share/xml/docbook/custom/slides/3.3.1')): + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): test.skip_test('No xsltproc executable or no "slides" stylesheets installed, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(arguments=['-f','SConstruct.cmd'], stderr=None) -test.must_exist(test.workpath('index.html')) -test.must_exist(test.workpath('toc.html')) -test.must_exist(test.workpath('foil01.html')) -test.must_exist(test.workpath('foilgroup01.html')) +test.must_not_be_empty(test.workpath('index.html')) +test.must_not_be_empty(test.workpath('toc.html')) +test.must_not_be_empty(test.workpath('foil01.html')) +test.must_not_be_empty(test.workpath('foilgroup01.html')) # Cleanup -test.run(arguments=['-f','SConstruct.cmd','-c']) +test.run(arguments=['-f','SConstruct.cmd','-c'], stderr=None) test.must_not_exist(test.workpath('index.html')) test.must_not_exist(test.workpath('toc.html')) test.must_not_exist(test.workpath('foil01.html')) diff --git a/test/Docbook/basic/slidespdf/image/SConstruct b/test/Docbook/basic/slidespdf/image/SConstruct new file mode 100644 index 0000000..e103f02 --- /dev/null +++ b/test/Docbook/basic/slidespdf/image/SConstruct @@ -0,0 +1,3 @@ +env = Environment(tools=['docbook']) +env.DocbookSlidesPdf('virt') + diff --git a/test/Docbook/basic/slidespdf/image/SConstruct.cmd b/test/Docbook/basic/slidespdf/image/SConstruct.cmd new file mode 100644 index 0000000..2000713 --- /dev/null +++ b/test/Docbook/basic/slidespdf/image/SConstruct.cmd @@ -0,0 +1,4 @@ +env = Environment(DOCBOOK_PREFER_XSLTPROC=1, tools=['docbook']) +env.Append(DOCBOOK_XSLTPROCFLAGS=['--novalid', '--nonet']) +env.DocbookSlidesPdf('virt') + diff --git a/test/Docbook/basic/slidespdf/image/virt.xml b/test/Docbook/basic/slidespdf/image/virt.xml new file mode 100644 index 0000000..9cdf778 --- /dev/null +++ b/test/Docbook/basic/slidespdf/image/virt.xml @@ -0,0 +1,33 @@ + + + + + Virtuelles Kopieren + + Virtuelles Kopieren + + + 2007 + + Femutec GmbH + + + + Dirk + + Baechle + + + 09.07.2007 + + + +Group + + sfForming + + + + + diff --git a/test/Docbook/basic/slidespdf/slidespdf.py b/test/Docbook/basic/slidespdf/slidespdf.py new file mode 100644 index 0000000..9e8f603 --- /dev/null +++ b/test/Docbook/basic/slidespdf/slidespdf.py @@ -0,0 +1,66 @@ +#!/usr/bin/env python +# +# Copyright (c) 2001-2010 The SCons Foundation +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +""" +Test the Slides PDF builder. +""" + +import os +import sys +import TestSCons + +test = TestSCons.TestSCons() + +if not (sys.platform.startswith('linux') and + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): + test.skip_test('Wrong OS or no "slides" stylesheets installed, skipping test.\n') + +fop = test.where_is('fop') +if not fop: + test.skip_test('No fop executable found, skipping test.\n') + +try: + import lxml +except: + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') + +test.dir_fixture('image') + +# Normal invocation +test.run(stderr=None) +test.must_not_be_empty(test.workpath('virt.fo')) +test.must_not_be_empty(test.workpath('virt.pdf')) + +# Cleanup +test.run(arguments='-c') +test.must_not_exist(test.workpath('virt.fo')) +test.must_not_exist(test.workpath('virt.pdf')) + +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: diff --git a/test/Docbook/basic/slidespdf/slidespdf_cmd.py b/test/Docbook/basic/slidespdf/slidespdf_cmd.py new file mode 100644 index 0000000..211e7b5 --- /dev/null +++ b/test/Docbook/basic/slidespdf/slidespdf_cmd.py @@ -0,0 +1,63 @@ +#!/usr/bin/env python +# +# Copyright (c) 2001-2010 The SCons Foundation +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +""" +Test the Slides PDF builder while using +the xsltproc executable, if it exists. +""" + +import os +import sys +import TestSCons + +test = TestSCons.TestSCons() + +xsltproc = test.where_is('xsltproc') +if not (xsltproc and + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): + test.skip_test('No xsltproc executable or no "slides" stylesheets installed, skipping test.\n') + +fop = test.where_is('fop') +if not fop: + test.skip_test('No fop executable found, skipping test.\n') + +test.dir_fixture('image') + +# Normal invocation +test.run(arguments=['-f','SConstruct.cmd'], stderr=None) +test.must_not_be_empty(test.workpath('virt.fo')) +test.must_not_be_empty(test.workpath('virt.pdf')) + +# Cleanup +test.run(arguments=['-f','SConstruct.cmd','-c'], stderr=None) +test.must_not_exist(test.workpath('virt.fo')) +test.must_not_exist(test.workpath('virt.pdf')) + +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: diff --git a/test/Docbook/basic/xinclude/xinclude.py b/test/Docbook/basic/xinclude/xinclude.py index 9b22c13..9074f0c 100644 --- a/test/Docbook/basic/xinclude/xinclude.py +++ b/test/Docbook/basic/xinclude/xinclude.py @@ -31,19 +31,15 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run() -test.must_exist(test.workpath('manual_xi.xml')) +test.must_not_be_empty(test.workpath('manual_xi.xml')) test.must_contain(test.workpath('manual_xi.xml'),'This is an included text.', mode='r') diff --git a/test/Docbook/basic/xslt/image/SConstruct b/test/Docbook/basic/xslt/image/SConstruct new file mode 100644 index 0000000..3e8ac4a --- /dev/null +++ b/test/Docbook/basic/xslt/image/SConstruct @@ -0,0 +1,9 @@ +import os + +env = Environment(tools=['docbook']) + +# +# Create document +# +env.DocbookXslt('out.xml', 'in.xml', + xsl='./to_docbook.xslt') diff --git a/test/Docbook/basic/xslt/image/in.xml b/test/Docbook/basic/xslt/image/in.xml new file mode 100644 index 0000000..4c1c41b --- /dev/null +++ b/test/Docbook/basic/xslt/image/in.xml @@ -0,0 +1,77 @@ + + + SCons 2.3.5 + User Guide + + + Steven + Knight + + + Steven Knight and the SCons Development Team + + 2004 - 2020 + + + 2004 - 2020 + The SCons Foundation + + + + +
+ + SCons User's Guide Copyright (c) 2004-2019 Steven Knight + +
+ + + + + version 2.3.5 + + + + + +Builders + +... + +
+Test + +... +
+ + + + +Construction Variables + + +In this appendix... + + + + + + 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. + + + +env = Environment(ASCOMSTR = "Assembling $TARGET") + + + + + + + + + diff --git a/test/Docbook/basic/xslt/image/to_docbook.xslt b/test/Docbook/basic/xslt/image/to_docbook.xslt new file mode 100644 index 0000000..0b39c28 --- /dev/null +++ b/test/Docbook/basic/xslt/image/to_docbook.xslt @@ -0,0 +1,102 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/test/Docbook/basic/xslt/xslt.py b/test/Docbook/basic/xslt/xslt.py new file mode 100644 index 0000000..0185423 --- /dev/null +++ b/test/Docbook/basic/xslt/xslt.py @@ -0,0 +1,57 @@ +#!/usr/bin/env python +# +# Copyright (c) 2001-2010 The SCons Foundation +# +# Permission is hereby granted, free of charge, to any person obtaining +# a copy of this software and associated documentation files (the +# "Software"), to deal in the Software without restriction, including +# without limitation the rights to use, copy, modify, merge, publish, +# distribute, sublicense, and/or sell copies of the Software, and to +# permit persons to whom the Software is furnished to do so, subject to +# the following conditions: +# +# The above copyright notice and this permission notice shall be included +# in all copies or substantial portions of the Software. +# +# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY +# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE +# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE +# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION +# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. +# + +""" +Test the Xslt builder. +""" + +import TestSCons + +test = TestSCons.TestSCons() + +try: + import lxml +except: + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') + +test.dir_fixture('image') + +# Normal invocation +test.run() +test.must_not_be_empty(test.workpath('out.xml')) +test.must_contain(test.workpath('out.xml'),'', mode='r') +test.must_not_contain(test.workpath('out.xml'),'', mode='r') + + +# Cleanup +test.run(arguments='-c') +test.must_not_exist(test.workpath('out.xml')) + +test.pass_test() + +# Local Variables: +# tab-width:4 +# indent-tabs-mode:nil +# End: +# vim: set expandtab tabstop=4 shiftwidth=4: diff --git a/test/Docbook/dependencies/xinclude/xinclude.py b/test/Docbook/dependencies/xinclude/xinclude.py index c3d9e25..15c9d6a 100644 --- a/test/Docbook/dependencies/xinclude/xinclude.py +++ b/test/Docbook/dependencies/xinclude/xinclude.py @@ -31,19 +31,15 @@ import TestSCons test = TestSCons.TestSCons() try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run() -test.must_exist(test.workpath('manual_xi.xml')) +test.must_not_be_empty(test.workpath('manual_xi.xml')) test.must_contain(test.workpath('manual_xi.xml'),'This is an included text.', mode='r') # Change included file @@ -54,7 +50,7 @@ test.not_up_to_date(options='-n', arguments='.') # The new file should contain the changes test.run() -test.must_exist(test.workpath('manual_xi.xml')) +test.must_not_be_empty(test.workpath('manual_xi.xml')) test.must_contain(test.workpath('manual_xi.xml'),'This is another text.') test.pass_test() diff --git a/test/Docbook/rootname/htmlchunked/htmlchunked.py b/test/Docbook/rootname/htmlchunked/htmlchunked.py index 65b50ef..cb2bb86 100644 --- a/test/Docbook/rootname/htmlchunked/htmlchunked.py +++ b/test/Docbook/rootname/htmlchunked/htmlchunked.py @@ -37,19 +37,15 @@ if not (sys.platform.startswith('linux') and test.skip_test('Wrong OS or no stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('manual.html')) +test.must_not_be_empty(test.workpath('manual.html')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/rootname/htmlhelp/htmlhelp.py b/test/Docbook/rootname/htmlhelp/htmlhelp.py index 9d0b076..45f9d7a 100644 --- a/test/Docbook/rootname/htmlhelp/htmlhelp.py +++ b/test/Docbook/rootname/htmlhelp/htmlhelp.py @@ -37,21 +37,17 @@ if not (sys.platform.startswith('linux') and test.skip_test('Wrong OS or no stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('manual.html')) -test.must_exist(test.workpath('htmlhelp.hhp')) -test.must_exist(test.workpath('toc.hhc')) +test.must_not_be_empty(test.workpath('manual.html')) +test.must_not_be_empty(test.workpath('htmlhelp.hhp')) +test.must_not_be_empty(test.workpath('toc.hhc')) # Cleanup test.run(arguments='-c') diff --git a/test/Docbook/rootname/slideshtml/image/virt.xml b/test/Docbook/rootname/slideshtml/image/virt.xml index aec1fd7..9cdf778 100644 --- a/test/Docbook/rootname/slideshtml/image/virt.xml +++ b/test/Docbook/rootname/slideshtml/image/virt.xml @@ -1,6 +1,6 @@ +"http://docbook.sourceforge.net/release/slides/3.3.1/schema/dtd/slides.dtd"> Virtuelles Kopieren diff --git a/test/Docbook/rootname/slideshtml/slideshtml.py b/test/Docbook/rootname/slideshtml/slideshtml.py index 399764b..3220522 100644 --- a/test/Docbook/rootname/slideshtml/slideshtml.py +++ b/test/Docbook/rootname/slideshtml/slideshtml.py @@ -33,27 +33,22 @@ import TestSCons test = TestSCons.TestSCons() if not (sys.platform.startswith('linux') and - os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides') and - os.path.isdir('/usr/share/xml/docbook/custom/slides/3.3.1')): + os.path.isdir('/usr/share/xml/docbook/stylesheet/docbook-xsl/slides')): test.skip_test('Wrong OS or no "slides" stylesheets installed, skipping test.\n') try: - import libxml2 - import libxslt + import lxml except: - try: - import lxml - except: - test.skip_test('Cannot find installed Python binding for libxml2 or lxml, skipping test.\n') + test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') # Normal invocation test.run(stderr=None) -test.must_exist(test.workpath('manual.html')) -test.must_exist(test.workpath('toc.html')) -test.must_exist(test.workpath('foil01.html')) -test.must_exist(test.workpath('foilgroup01.html')) +test.must_not_be_empty(test.workpath('manual.html')) +test.must_not_be_empty(test.workpath('toc.html')) +test.must_not_be_empty(test.workpath('foil01.html')) +test.must_not_be_empty(test.workpath('foilgroup01.html')) # Cleanup test.run(arguments='-c') diff --git a/testing/framework/TestCommon.py b/testing/framework/TestCommon.py index 9c4d116..35bf365 100644 --- a/testing/framework/TestCommon.py +++ b/testing/framework/TestCommon.py @@ -56,6 +56,8 @@ provided by the TestCommon class: test.must_not_exist('file1', ['file2', ...]) + test.must_not_be_empty('file') + test.run(options = "options to be prepended to arguments", stdout = "expected standard output from the program", stderr = "expected error output from the program", @@ -568,6 +570,23 @@ class TestCommon(TestCmd): print("Unexpected files exist: `%s'" % "', `".join(existing)) self.fail_test(existing) + def must_not_be_empty(self, file): + """Ensures that the specified file exists, and that it is not empty. + Exits FAILED if the file doesn't exist or is empty. + """ + if not (os.path.exists(file) or os.path.islink(file)): + print("File doesn't exist: `%s'" % file) + self.fail_test(file) + + try: + fsize = os.path.getsize(file) + except OSError: + fsize = 0 + + if fsize == 0: + print("File is empty: `%s'" % file) + self.fail_test(file) + def must_not_be_writable(self, *files): """Ensures that the specified file(s) exist and are not writable. An individual file can be specified as a list of directory names, diff --git a/testing/framework/TestCommonTests.py b/testing/framework/TestCommonTests.py index 01e9fe1..6c9e92d 100644 --- a/testing/framework/TestCommonTests.py +++ b/testing/framework/TestCommonTests.py @@ -1784,6 +1784,57 @@ class must_not_exist_any_of_TestCase(TestCommonTestCase): stderr = run_env.stderr() assert stderr == "PASSED\n", stderr +class must_not_be_empty_TestCase(TestCommonTestCase): + def test_failure(self): + """Test must_not_be_empty(): failure""" + run_env = self.run_env + + script = lstrip("""\ + from TestCommon import TestCommon + tc = TestCommon(workdir='') + tc.write('file1', "") + tc.must_not_be_empty('file1') + tc.pass_test() + """) + run_env.run(program=sys.executable, stdin=script) + stdout = run_env.stdout() + assert stdout == "File is empty: `file1'\n", stdout + stderr = run_env.stderr() + assert stderr.find("FAILED") != -1, stderr + + def test_success(self): + """Test must_not_be_empty(): success""" + run_env = self.run_env + + script = lstrip("""\ + from TestCommon import TestCommon + tc = TestCommon(workdir='') + tc.write('file1', "file1\\n") + tc.must_not_be_empty('file1') + tc.pass_test() + """) + run_env.run(program=sys.executable, stdin=script) + stdout = run_env.stdout() + assert stdout == "", stdout + stderr = run_env.stderr() + assert stderr == "PASSED\n", stderr + + def test_file_doesnt_exist(self): + """Test must_not_be_empty(): failure""" + run_env = self.run_env + + script = lstrip("""\ + from TestCommon import TestCommon + tc = TestCommon(workdir='') + tc.must_not_be_empty('file1') + tc.pass_test() + """) + run_env.run(program=sys.executable, stdin=script) + stdout = run_env.stdout() + assert stdout == "File doesn't exist: `file1'\n", stdout + stderr = run_env.stderr() + assert stderr.find("FAILED") != -1, stderr + class run_TestCase(TestCommonTestCase): def test_argument_handling(self): """Test run(): argument handling""" @@ -2372,6 +2423,7 @@ if __name__ == "__main__": must_not_contain_lines_TestCase, must_not_exist_TestCase, must_not_exist_any_of_TestCase, + must_not_be_empty_TestCase, run_TestCase, start_TestCase, skip_test_TestCase, -- cgit v0.12 From 0d9a84e0d8ab4d726ad1fdf376771e596467893d Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Sun, 21 Jun 2020 16:21:51 +0200 Subject: Fixed another bunch of 'bare except' errors. --- test/Docbook/basedir/htmlchunked/htmlchunked.py | 2 +- test/Docbook/basedir/htmlhelp/htmlhelp.py | 2 +- test/Docbook/basedir/slideshtml/slideshtml.py | 2 +- test/Docbook/basic/epub/epub.py | 2 +- test/Docbook/basic/html/html.py | 2 +- test/Docbook/basic/htmlchunked/htmlchunked.py | 2 +- test/Docbook/basic/htmlhelp/htmlhelp.py | 2 +- test/Docbook/basic/man/man.py | 2 +- test/Docbook/basic/pdf/pdf.py | 2 +- test/Docbook/basic/slideshtml/slideshtml.py | 2 +- test/Docbook/basic/slidespdf/slidespdf.py | 2 +- test/Docbook/basic/xinclude/xinclude.py | 2 +- test/Docbook/basic/xslt/xslt.py | 2 +- test/Docbook/dependencies/xinclude/xinclude.py | 2 +- test/Docbook/rootname/htmlchunked/htmlchunked.py | 2 +- test/Docbook/rootname/htmlhelp/htmlhelp.py | 2 +- test/Docbook/rootname/slideshtml/slideshtml.py | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/test/Docbook/basedir/htmlchunked/htmlchunked.py b/test/Docbook/basedir/htmlchunked/htmlchunked.py index 893761c..8822487 100644 --- a/test/Docbook/basedir/htmlchunked/htmlchunked.py +++ b/test/Docbook/basedir/htmlchunked/htmlchunked.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basedir/htmlhelp/htmlhelp.py b/test/Docbook/basedir/htmlhelp/htmlhelp.py index 7fbc875..171fd57 100644 --- a/test/Docbook/basedir/htmlhelp/htmlhelp.py +++ b/test/Docbook/basedir/htmlhelp/htmlhelp.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basedir/slideshtml/slideshtml.py b/test/Docbook/basedir/slideshtml/slideshtml.py index de3cd83..b4bdec3 100644 --- a/test/Docbook/basedir/slideshtml/slideshtml.py +++ b/test/Docbook/basedir/slideshtml/slideshtml.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/epub/epub.py b/test/Docbook/basic/epub/epub.py index e2b37a1..ffbde4b 100644 --- a/test/Docbook/basic/epub/epub.py +++ b/test/Docbook/basic/epub/epub.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/html/html.py b/test/Docbook/basic/html/html.py index d6a3114..d445b2d 100644 --- a/test/Docbook/basic/html/html.py +++ b/test/Docbook/basic/html/html.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/htmlchunked/htmlchunked.py b/test/Docbook/basic/htmlchunked/htmlchunked.py index 71f6265..8839915 100644 --- a/test/Docbook/basic/htmlchunked/htmlchunked.py +++ b/test/Docbook/basic/htmlchunked/htmlchunked.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/htmlhelp/htmlhelp.py b/test/Docbook/basic/htmlhelp/htmlhelp.py index 37c4879..e49586e 100644 --- a/test/Docbook/basic/htmlhelp/htmlhelp.py +++ b/test/Docbook/basic/htmlhelp/htmlhelp.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/man/man.py b/test/Docbook/basic/man/man.py index d8cd716..843e82b 100644 --- a/test/Docbook/basic/man/man.py +++ b/test/Docbook/basic/man/man.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/pdf/pdf.py b/test/Docbook/basic/pdf/pdf.py index 1268fde..e9bae34 100644 --- a/test/Docbook/basic/pdf/pdf.py +++ b/test/Docbook/basic/pdf/pdf.py @@ -36,7 +36,7 @@ if not fop: try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/slideshtml/slideshtml.py b/test/Docbook/basic/slideshtml/slideshtml.py index ae9200f..2cfe3e8 100644 --- a/test/Docbook/basic/slideshtml/slideshtml.py +++ b/test/Docbook/basic/slideshtml/slideshtml.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/slidespdf/slidespdf.py b/test/Docbook/basic/slidespdf/slidespdf.py index 9e8f603..32e2dc4 100644 --- a/test/Docbook/basic/slidespdf/slidespdf.py +++ b/test/Docbook/basic/slidespdf/slidespdf.py @@ -42,7 +42,7 @@ if not fop: try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/xinclude/xinclude.py b/test/Docbook/basic/xinclude/xinclude.py index 9074f0c..ea82521 100644 --- a/test/Docbook/basic/xinclude/xinclude.py +++ b/test/Docbook/basic/xinclude/xinclude.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/basic/xslt/xslt.py b/test/Docbook/basic/xslt/xslt.py index 0185423..1633766 100644 --- a/test/Docbook/basic/xslt/xslt.py +++ b/test/Docbook/basic/xslt/xslt.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/dependencies/xinclude/xinclude.py b/test/Docbook/dependencies/xinclude/xinclude.py index 15c9d6a..07b050d 100644 --- a/test/Docbook/dependencies/xinclude/xinclude.py +++ b/test/Docbook/dependencies/xinclude/xinclude.py @@ -32,7 +32,7 @@ test = TestSCons.TestSCons() try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/rootname/htmlchunked/htmlchunked.py b/test/Docbook/rootname/htmlchunked/htmlchunked.py index cb2bb86..b40009a 100644 --- a/test/Docbook/rootname/htmlchunked/htmlchunked.py +++ b/test/Docbook/rootname/htmlchunked/htmlchunked.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/rootname/htmlhelp/htmlhelp.py b/test/Docbook/rootname/htmlhelp/htmlhelp.py index 45f9d7a..c6dbcbe 100644 --- a/test/Docbook/rootname/htmlhelp/htmlhelp.py +++ b/test/Docbook/rootname/htmlhelp/htmlhelp.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') diff --git a/test/Docbook/rootname/slideshtml/slideshtml.py b/test/Docbook/rootname/slideshtml/slideshtml.py index 3220522..2d8500e 100644 --- a/test/Docbook/rootname/slideshtml/slideshtml.py +++ b/test/Docbook/rootname/slideshtml/slideshtml.py @@ -38,7 +38,7 @@ if not (sys.platform.startswith('linux') and try: import lxml -except: +except Exception: test.skip_test('Cannot find installed Python binding for lxml, skipping test.\n') test.dir_fixture('image') -- cgit v0.12 From df076578e8f3d9e5019570ba8a466ee0fda8b7d6 Mon Sep 17 00:00:00 2001 From: Dirk Baechle Date: Sun, 21 Jun 2020 21:40:23 +0200 Subject: Removed superfluous import of 'sys' in a testcase. --- test/Docbook/basic/slidespdf/slidespdf_cmd.py | 1 - 1 file changed, 1 deletion(-) diff --git a/test/Docbook/basic/slidespdf/slidespdf_cmd.py b/test/Docbook/basic/slidespdf/slidespdf_cmd.py index 211e7b5..4b7bd2c 100644 --- a/test/Docbook/basic/slidespdf/slidespdf_cmd.py +++ b/test/Docbook/basic/slidespdf/slidespdf_cmd.py @@ -28,7 +28,6 @@ the xsltproc executable, if it exists. """ import os -import sys import TestSCons test = TestSCons.TestSCons() -- cgit v0.12