diff options
40 files changed, 1532 insertions, 980 deletions
diff --git a/bin/SConsDoc.py b/bin/SConsDoc.py index e3eaf0f3..db595c87 100644 --- a/bin/SConsDoc.py +++ b/bin/SConsDoc.py @@ -1,5 +1,27 @@ #!/usr/bin/env python # +# Copyright (c) 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. +# +# # Module for handling SCons documentation processing. # @@ -16,13 +38,12 @@ Builder example: <builder name="BUILDER"> <summary> - This is the summary description of an SCons Builder. + <para>This is the summary description of an SCons Builder. It will get placed in the man page, and in the appropriate User's Guide appendix. The name of any builder may be interpolated anywhere in the document by specifying the - &b-BUILDER; - element. It need not be on a line by itself. + &b-BUILDER; element. It need not be on a line by itself.</para> Unlike normal XML, blank lines are significant in these descriptions and serve to separate paragraphs. @@ -42,18 +63,12 @@ Function example: (arg1, arg2, key=value) </arguments> <summary> - This is the summary description of an SCons function. + <para>This is the summary description of an SCons function. It will get placed in the man page, and in the appropriate User's Guide appendix. The name of any builder may be interpolated anywhere in the document by specifying the - &f-FUNCTION; - element. It need not be on a line by itself. - - Unlike normal XML, blank lines are significant in these - descriptions and serve to separate paragraphs. - They'll get replaced in DocBook output with appropriate tags - to indicate a new paragraph. + &f-FUNCTION; element. It need not be on a line by itself.</para> <example> print "this is example code, it will be offset and indented" @@ -65,18 +80,12 @@ Construction variable example: <cvar name="VARIABLE"> <summary> - This is the summary description of a construction variable. + <para>This is the summary description of a construction variable. It will get placed in the man page, and in the appropriate User's Guide appendix. The name of any construction variable may be interpolated anywhere in the document by specifying the - &t-VARIABLE; - element. It need not be on a line by itself. - - Unlike normal XML, blank lines are significant in these - descriptions and serve to separate paragraphs. - They'll get replaced in DocBook output with appropriate tags - to indicate a new paragraph. + &t-VARIABLE; element. It need not be on a line by itself.</para> <example> print "this is example code, it will be offset and indented" @@ -88,18 +97,12 @@ Tool example: <tool name="TOOL"> <summary> - This is the summary description of an SCons Tool. + <para>This is the summary description of an SCons Tool. It will get placed in the man page, and in the appropriate User's Guide appendix. The name of any tool may be interpolated anywhere in the document by specifying the - &t-TOOL; - element. It need not be on a line by itself. - - Unlike normal XML, blank lines are significant in these - descriptions and serve to separate paragraphs. - They'll get replaced in DocBook output with appropriate tags - to indicate a new paragraph. + &t-TOOL; element. It need not be on a line by itself.</para> <example> print "this is example code, it will be offset and indented" @@ -184,7 +187,7 @@ def isSConsXml(fpath): f = open(fpath,'r') content = f.read() f.close() - if content.find(dbxsd) >= 0: + if content.find('xmlns="%s"' % dbxsd) >= 0: return True except: pass @@ -263,6 +266,14 @@ if not has_libxml2: def newNode(self, tag): return etree.Element(tag) + + def newEtreeNode(self, tag, init_ns=False): + if init_ns: + NSMAP = {None: dbxsd, + 'xsi' : xsi} + return etree.Element(tag, nsmap=NSMAP) + + return etree.Element(tag) def copyNode(self, node): return copy.deepcopy(node) @@ -291,6 +302,12 @@ if not has_libxml2: encoding="UTF-8", pretty_print=True, doctype=dt.createDoctype())) + def writeTree(self, root, fpath): + fp = open(fpath, 'w') + fp.write(etree.tostring(root, xml_declaration=True, + encoding="UTF-8", pretty_print=True)) + fp.close() + def prettyPrintFile(self, fpath): fin = open(fpath,'r') tree = etree.parse(fin) @@ -300,6 +317,14 @@ if not has_libxml2: fout = open(fpath,'w') fout.write(pretty_content) fout.close() + + def decorateWithCommentHeader(self, root, comment=generated_comment): + root.attrib["{"+xsi+"}schemaLocation"] = "%s scons.xsd" % dbxsd + + c = etree.Comment(comment) + root.insert(0, c) + + return root def newXmlTree(self, root, comment=generated_comment): """ Return a XML file tree with the correct namespaces set, @@ -307,15 +332,8 @@ if not has_libxml2: """ NSMAP = {None: dbxsd, 'xsi' : xsi} - - t = etree.Element(root, - nsmap = NSMAP, - attrib = {"{"+xsi+"}schemaLocation" : "%s scons.xsd" % dbxsd}) - - c = etree.Comment(comment) - t.append(c) - - return t + t = etree.Element(root, nsmap=NSMAP) + return self.decorateWithCommentHeader(t, comment) def validateXml(self, fpath, xmlschema_context): # Use lxml @@ -342,6 +360,13 @@ if not has_libxml2: expression = "./%s/*" % tag return root.findall(expression) + def convertElementTree(self, root): + """ Convert the given tree of etree.Element + entries to a list of tree nodes for the + current XML toolkit. + """ + return [root] + else: class TreeFactory: def __init__(self): @@ -349,6 +374,9 @@ else: def newNode(self, tag): return libxml2.newNode(tag) + + def newEtreeNode(self, tag, init_ns=False): + return etree.Element(tag) def copyNode(self, node): return node.copyNode(1) @@ -401,6 +429,14 @@ else: fp.write(content) doc.freeDoc() + def writeTree(self, root, fpath): + fp = open(fpath, 'w') + doc = libxml2.newDoc('1.0') + doc.setRootElement(root) + fp.write(doc.serialize("UTF-8", 1)) + doc.freeDoc() + fp.close() + def prettyPrintFile(self, fpath): # Read file and resolve entities doc = libxml2.readFile(fpath, None, libxml2d.XML_PARSE_NOENT) @@ -411,22 +447,25 @@ else: # Cleanup doc.freeDoc() + def decorateWithCommentHeader(self, root, comment=generated_comment): + # 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 scons.xsd" % dbxsd) + + c = libxml2.newComment(comment) + root.addChild(c) + + return root + def newXmlTree(self, root, comment=generated_comment): """ 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) - # Register the namespaces - ns = t.newNs(dbxsd, None) - xi = t.newNs(xsi, 'xsi') - t.setNs(ns) #put this node in the target namespace - - t.setNsProp(xi, 'schemaLocation', "%s scons.xsd" % dbxsd) - - c = libxml2.newComment(comment) - t.addChild(c) - - return t + return self.decorateWithCommentHeader(t, comment) def validateXml(self, fpath, xmlschema_context): # Create validation context @@ -479,6 +518,56 @@ else: 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 tf = TreeFactory() diff --git a/bin/SConsExamples.py b/bin/SConsExamples.py index 77f40418..cba248b9 100644 --- a/bin/SConsExamples.py +++ b/bin/SConsExamples.py @@ -1,13 +1,96 @@ #!/usr/bin/env python # -# Module for handling SCons examples processing. +# Copyright (c) 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. -__doc__ = """ -""" +# +# +# This script looks for some XML tags that describe SCons example +# configurations and commands to execute in those configurations, and +# uses TestCmd.py to execute the commands and insert the output from +# those commands into the XML that we output. This way, we can run a +# script and update all of our example documentation output without +# a lot of laborious by-hand checking. +# +# An "SCons example" looks like this, and essentially describes a set of +# input files (program source files as well as SConscript files): +# +# <scons_example name="ex1"> +# <file name="SConstruct" printme="1"> +# env = Environment() +# env.Program('foo') +# </file> +# <file name="foo.c"> +# int main() { printf("foo.c\n"); } +# </file> +# </scons_example> +# +# The <file> contents within the <scons_example> tag will get written +# into a temporary directory whenever example output needs to be +# generated. By default, the <file> contents are not inserted into text +# directly, unless you set the "printme" attribute on one or more files, +# in which case they will get inserted within a <programlisting> tag. +# This makes it easy to define the example at the appropriate +# point in the text where you intend to show the SConstruct file. +# +# Note that you should usually give the <scons_example> a "name" +# attribute so that you can refer to the example configuration later to +# run SCons and generate output. +# +# If you just want to show a file's contents without worry about running +# SCons, there's a shorter <sconstruct> tag: +# +# <sconstruct> +# env = Environment() +# env.Program('foo') +# </sconstruct> +# +# This is essentially equivalent to <scons_example><file printme="1">, +# but it's more straightforward. +# +# SCons output is generated from the following sort of tag: +# +# <scons_output example="ex1" os="posix"> +# <scons_output_command suffix="1">scons -Q foo</scons_output_command> +# <scons_output_command suffix="2">scons -Q foo</scons_output_command> +# </scons_output> +# +# You tell it which example to use with the "example" attribute, and then +# give it a list of <scons_output_command> tags to execute. You can also +# supply an "os" tag, which specifies the type of operating system this +# example is intended to show; if you omit this, default value is "posix". +# +# The generated XML will show the command line (with the appropriate +# command-line prompt for the operating system), execute the command in +# a temporary directory with the example files, capture the standard +# output from SCons, and insert it into the text as appropriate. +# Error output gets passed through to your error output so you +# can see if there are any problems executing the command. +# import os import re +import sys +import time + import SConsDoc from SConsDoc import tf as stf @@ -34,17 +117,18 @@ class ExampleFolder: class ExampleCommand: def __init__(self): - self.edit = '' + self.edit = None self.environment = '' self.output = '' self.cmd = '' - self.suffix = '' class ExampleOutput: def __init__(self): self.name = '' self.tools = '' - self.os = '' + self.os = 'posix' + self.preserve = None + self.suffix = '' self.commands = [] class ExampleInfo: @@ -132,16 +216,12 @@ def readExampleInfos(fpath, examples): eout.tools = stf.getAttribute(o, 'tools') if stf.hasAttribute(o, 'os'): eout.os = stf.getAttribute(o, 'os') + if stf.hasAttribute(o, 'suffix'): + eout.suffix = stf.getAttribute(o, 'suffix') for c in stf.findAll(o, "scons_output_command", SConsDoc.dbxid, t.xpath_context, t.nsmap): - if stf.hasAttribute(c, 'suffix'): - s = stf.getAttribute(c, 'suffix') - else: - continue - oc = ExampleCommand() - oc.suffix = s if stf.hasAttribute(c, 'edit'): oc.edit = stf.getAttribute(c, 'edit') if stf.hasAttribute(c, 'environment'): @@ -150,6 +230,8 @@ def readExampleInfos(fpath, examples): oc.output = stf.getAttribute(c, 'output') if stf.hasAttribute(c, 'cmd'): oc.cmd = stf.getAttribute(c, 'cmd') + else: + oc.cmd = stf.getText(c) eout.commands.append(oc) @@ -186,17 +268,15 @@ def ensureExampleOutputsExist(dpath): for key, value in examples.iteritems(): # Process all scons_output tags for o in value.outputs: - for c in o.commands: - cpath = os.path.join(generated_examples, - key+'_'+c.suffix+'.out') - if not os.path.isfile(cpath): - content = c.output - if not content: - content = "NO OUTPUT YET! Run the script to generate/update all examples." - - f = open(cpath, 'w') - f.write("%s\n" % content) - f.close() + cpath = os.path.join(generated_examples, + key+'_'+o.suffix+'.xml') + if not os.path.isfile(cpath): + # Start new XML file + s = stf.newXmlTree("screen") + stf.setText(s, "NO OUTPUT YET! Run the script to generate/update all examples.") + # Write file + stf.writeTree(s, cpath) + # Process all scons_example_file tags for r in value.files: if r.isFileRef(): @@ -209,6 +289,39 @@ def ensureExampleOutputsExist(dpath): f.write("%s\n" % content) f.close() +perc = "%" + +def createAllExampleOutputs(dpath): + """ Scan for XML files in the given directory and + creates all output files for every example in + the 'generated/examples' folder. + """ + # Ensure that the output folder exists + if not os.path.isdir(generated_examples): + os.mkdir(generated_examples) + + examples = readAllExampleInfos(dpath) + total = len(examples) + idx = 0 + for key, value in examples.iteritems(): + # Process all scons_output tags + print "%.2f%s (%d/%d) %s" % (float(idx+1)*100.0/float(total), + perc, idx+1, total, key) + + create_scons_output(value) + # Process all scons_example_file tags + for r in value.files: + if r.isFileRef(): + # Get file's content + content = value.getFileContents(r.name) + fpath = os.path.join(generated_examples, + key+'_'+r.name.replace("/","_")) + # Write file + f = open(fpath, 'w') + f.write("%s\n" % content) + f.close() + idx += 1 + def collectSConsExampleNames(fpath): """ Return a set() of example names, used in the given file fpath. """ @@ -248,20 +361,18 @@ def collectSConsExampleNames(fpath): failed_suffixes = True continue - for c in stf.findAll(o, "scons_output_command", SConsDoc.dbxid, - t.xpath_context, t.nsmap): - s = '' - if stf.hasAttribute(c, 'suffix'): - s = stf.getAttribute(c, 'suffix') - else: - print "Error: scons_output_command in file '%s' (example '%s') is missing a suffix!" % (fpath, n) - failed_suffixes = True - - if s not in suffixes[n]: - suffixes[n].append(s) - else: - print "Error: scons_output_command in file '%s' (example '%s') is using a duplicate suffix '%s'!" % (fpath, n, s) - failed_suffixes = True + s = '' + if stf.hasAttribute(o, 'suffix'): + s = stf.getAttribute(o, 'suffix') + else: + print "Error: scons_output in file '%s' (example '%s') is missing a suffix!" % (fpath, n) + failed_suffixes = True + + if s not in suffixes[n]: + suffixes[n].append(s) + else: + print "Error: scons_output in file '%s' (example '%s') is using a duplicate suffix '%s'!" % (fpath, n, s) + failed_suffixes = True return names, failed_suffixes @@ -288,6 +399,498 @@ def exampleNamesAreUnique(dpath): return unique +################################################################ +# +# In the second half of this module (starting here) +# we define the variables and functions that are required +# to actually run the examples, collect their output and +# write it into the files in doc/generated/examples... +# which then get included by our UserGuide. +# +################################################################ + +sys.path.append(os.path.join(os.getcwd(), 'QMTest')) +sys.path.append(os.path.join(os.getcwd(), 'build', 'QMTest')) + +scons_py = os.path.join('bootstrap', 'src', 'script', 'scons.py') +if not os.path.exists(scons_py): + scons_py = os.path.join('src', 'script', 'scons.py') + +scons_lib_dir = os.path.join(os.getcwd(), 'bootstrap', 'src', 'engine') +if not os.path.exists(scons_lib_dir): + scons_lib_dir = os.path.join(os.getcwd(), 'src', 'engine') + +os.environ['SCONS_LIB_DIR'] = scons_lib_dir + +import TestCmd + +Prompt = { + 'posix' : '% ', + 'win32' : 'C:\\>' +} + +# The magick SCons hackery that makes this work. +# +# So that our examples can still use the default SConstruct file, we +# actually feed the following into SCons via stdin and then have it +# SConscript() the SConstruct file. This stdin wrapper creates a set +# of ToolSurrogates for the tools for the appropriate platform. These +# Surrogates print output like the real tools and behave like them +# without actually having to be on the right platform or have the right +# tool installed. +# +# The upshot: The wrapper transparently changes the world out from +# under the top-level SConstruct file in an example just so we can get +# the command output. + +Stdin = """\ +import os +import re +import SCons.Action +import SCons.Defaults +import SCons.Node.FS + +platform = '%(osname)s' + +Sep = { + 'posix' : '/', + 'win32' : '\\\\', +}[platform] + + +# Slip our own __str__() method into the EntryProxy class used to expand +# $TARGET{S} and $SOURCE{S} to translate the path-name separators from +# what's appropriate for the system we're running on to what's appropriate +# for the example system. +orig = SCons.Node.FS.EntryProxy +class MyEntryProxy(orig): + def __str__(self): + return str(self._subject).replace(os.sep, Sep) +SCons.Node.FS.EntryProxy = MyEntryProxy + +# Slip our own RDirs() method into the Node.FS.File class so that the +# expansions of $_{CPPINC,F77INC,LIBDIR}FLAGS will have the path-name +# separators translated from what's appropriate for the system we're +# running on to what's appropriate for the example system. +orig_RDirs = SCons.Node.FS.File.RDirs +def my_RDirs(self, pathlist, orig_RDirs=orig_RDirs): + return [str(x).replace(os.sep, Sep) for x in orig_RDirs(self, pathlist)] +SCons.Node.FS.File.RDirs = my_RDirs + +class Curry(object): + def __init__(self, fun, *args, **kwargs): + self.fun = fun + self.pending = args[:] + self.kwargs = kwargs.copy() + + def __call__(self, *args, **kwargs): + if kwargs and self.kwargs: + kw = self.kwargs.copy() + kw.update(kwargs) + else: + kw = kwargs or self.kwargs + + return self.fun(*self.pending + args, **kw) + +def Str(target, source, env, cmd=""): + result = [] + for cmd in env.subst_list(cmd, target=target, source=source): + result.append(' '.join(map(str, cmd))) + return '\\n'.join(result) + +class ToolSurrogate(object): + def __init__(self, tool, variable, func, varlist): + self.tool = tool + if not isinstance(variable, list): + variable = [variable] + self.variable = variable + self.func = func + self.varlist = varlist + def __call__(self, env): + t = Tool(self.tool) + t.generate(env) + for v in self.variable: + orig = env[v] + try: + strfunction = orig.strfunction + except AttributeError: + strfunction = Curry(Str, cmd=orig) + # Don't call Action() through its global function name, because + # that leads to infinite recursion in trying to initialize the + # Default Environment. + env[v] = SCons.Action.Action(self.func, + strfunction=strfunction, + varlist=self.varlist) + def __repr__(self): + # This is for the benefit of printing the 'TOOLS' + # variable through env.Dump(). + return repr(self.tool) + +def Null(target, source, env): + pass + +def Cat(target, source, env): + target = str(target[0]) + f = open(target, "wb") + for src in map(str, source): + f.write(open(src, "rb").read()) + f.close() + +def CCCom(target, source, env): + target = str(target[0]) + fp = open(target, "wb") + def process(source_file, fp=fp): + for line in open(source_file, "rb").readlines(): + m = re.match(r'#include\s[<"]([^<"]+)[>"]', line) + if m: + include = m.group(1) + for d in [str(env.Dir('$CPPPATH')), '.']: + f = os.path.join(d, include) + if os.path.exists(f): + process(f) + break + elif line[:11] != "STRIP CCCOM": + fp.write(line) + for src in map(str, source): + process(src) + fp.write('debug = ' + ARGUMENTS.get('debug', '0') + '\\n') + fp.close() + +public_class_re = re.compile('^public class (\S+)', re.MULTILINE) + +def JavaCCom(target, source, env): + # This is a fake Java compiler that just looks for + # public class FooBar + # lines in the source file(s) and spits those out + # to .class files named after the class. + tlist = list(map(str, target)) + not_copied = {} + for t in tlist: + not_copied[t] = 1 + for src in map(str, source): + contents = open(src, "rb").read() + classes = public_class_re.findall(contents) + for c in classes: + for t in [x for x in tlist if x.find(c) != -1]: + open(t, "wb").write(contents) + del not_copied[t] + for t in not_copied.keys(): + open(t, "wb").write("\\n") + +def JavaHCom(target, source, env): + tlist = map(str, target) + slist = map(str, source) + for t, s in zip(tlist, slist): + open(t, "wb").write(open(s, "rb").read()) + +def JarCom(target, source, env): + target = str(target[0]) + class_files = [] + for src in map(str, source): + for dirpath, dirnames, filenames in os.walk(src): + class_files.extend([ os.path.join(dirpath, f) + for f in filenames if f.endswith('.class') ]) + f = open(target, "wb") + for cf in class_files: + f.write(open(cf, "rb").read()) + f.close() + +# XXX Adding COLOR, COLORS and PACKAGE to the 'cc' varlist(s) by hand +# here is bogus. It's for the benefit of doc/user/command-line.in, which +# uses examples that want to rebuild based on changes to these variables. +# It would be better to figure out a way to do it based on the content of +# the generated command-line, or else find a way to let the example markup +# language in doc/user/command-line.in tell this script what variables to +# add, but that's more difficult than I want to figure out how to do right +# now, so let's just use the simple brute force approach for the moment. + +ToolList = { + 'posix' : [('cc', ['CCCOM', 'SHCCCOM'], CCCom, ['CCFLAGS', 'CPPDEFINES', 'COLOR', 'COLORS', 'PACKAGE']), + ('link', ['LINKCOM', 'SHLINKCOM'], Cat, []), + ('ar', ['ARCOM', 'RANLIBCOM'], Cat, []), + ('tar', 'TARCOM', Null, []), + ('zip', 'ZIPCOM', Null, []), + ('BitKeeper', 'BITKEEPERCOM', Cat, []), + ('CVS', 'CVSCOM', Cat, []), + ('RCS', 'RCS_COCOM', Cat, []), + ('SCCS', 'SCCSCOM', Cat, []), + ('javac', 'JAVACCOM', JavaCCom, []), + ('javah', 'JAVAHCOM', JavaHCom, []), + ('jar', 'JARCOM', JarCom, []), + ('rmic', 'RMICCOM', Cat, []), + ], + 'win32' : [('msvc', ['CCCOM', 'SHCCCOM', 'RCCOM'], CCCom, ['CCFLAGS', 'CPPDEFINES', 'COLOR', 'COLORS', 'PACKAGE']), + ('mslink', ['LINKCOM', 'SHLINKCOM'], Cat, []), + ('mslib', 'ARCOM', Cat, []), + ('tar', 'TARCOM', Null, []), + ('zip', 'ZIPCOM', Null, []), + ('BitKeeper', 'BITKEEPERCOM', Cat, []), + ('CVS', 'CVSCOM', Cat, []), + ('RCS', 'RCS_COCOM', Cat, []), + ('SCCS', 'SCCSCOM', Cat, []), + ('javac', 'JAVACCOM', JavaCCom, []), + ('javah', 'JAVAHCOM', JavaHCom, []), + ('jar', 'JARCOM', JarCom, []), + ('rmic', 'RMICCOM', Cat, []), + ], +} + +toollist = ToolList[platform] +filter_tools = '%(tools)s'.split() +if filter_tools: + toollist = [x for x in toollist if x[0] in filter_tools] + +toollist = [ToolSurrogate(*t) for t in toollist] + +toollist.append('install') + +def surrogate_spawn(sh, escape, cmd, args, env): + pass + +def surrogate_pspawn(sh, escape, cmd, args, env, stdout, stderr): + pass + +SCons.Defaults.ConstructionEnvironment.update({ + 'PLATFORM' : platform, + 'TOOLS' : toollist, + 'SPAWN' : surrogate_spawn, + 'PSPAWN' : surrogate_pspawn, +}) + +SConscript('SConstruct') +""" + +# "Commands" that we will execute in our examples. +def command_scons(args, c, test, dict): + save_vals = {} + delete_keys = [] + try: + ce = c.environment + except AttributeError: + pass + else: + for arg in c.environment.split(): + key, val = arg.split('=') + try: + save_vals[key] = os.environ[key] + except KeyError: + delete_keys.append(key) + os.environ[key] = val + test.run(interpreter = sys.executable, + program = scons_py, + # We use ToolSurrogates to capture win32 output by "building" + # examples using a fake win32 tool chain. Suppress the + # warnings that come from the new revamped VS support so + # we can build doc on (Linux) systems that don't have + # Visual C installed. + arguments = '--warn=no-visual-c-missing -f - ' + ' '.join(args), + chdir = test.workpath('WORK'), + stdin = Stdin % dict) + os.environ.update(save_vals) + for key in delete_keys: + del(os.environ[key]) + out = test.stdout() + out = out.replace(test.workpath('ROOT'), '') + out = out.replace(test.workpath('WORK/SConstruct'), + '/home/my/project/SConstruct') + lines = out.split('\n') + if lines: + while lines[-1] == '': + lines = lines[:-1] + #err = test.stderr() + #if err: + # sys.stderr.write(err) + return lines + +def command_touch(args, c, test, dict): + if args[0] == '-t': + t = int(time.mktime(time.strptime(args[1], '%Y%m%d%H%M'))) + times = (t, t) + args = args[2:] + else: + time.sleep(1) + times = None + for file in args: + if not os.path.isabs(file): + file = os.path.join(test.workpath('WORK'), file) + if not os.path.exists(file): + open(file, 'wb') + os.utime(file, times) + return [] + +def command_edit(args, c, test, dict): + if c.edit is None: + add_string = 'void edit(void) { ; }\n' + else: + add_string = c.edit[:] + if add_string[-1] != '\n': + add_string = add_string + '\n' + for file in args: + if not os.path.isabs(file): + file = os.path.join(test.workpath('WORK'), file) + contents = open(file, 'rb').read() + open(file, 'wb').write(contents + add_string) + return [] + +def command_ls(args, c, test, dict): + def ls(a): + return [' '.join(sorted([x for x in os.listdir(a) if x[0] != '.']))] + if args: + l = [] + for a in args: + l.extend(ls(test.workpath('WORK', a))) + return l + else: + return ls(test.workpath('WORK')) + +def command_sleep(args, c, test, dict): + time.sleep(int(args[0])) + +CommandDict = { + 'scons' : command_scons, + 'touch' : command_touch, + 'edit' : command_edit, + 'ls' : command_ls, + 'sleep' : command_sleep, +} + +def ExecuteCommand(args, c, t, dict): + try: + func = CommandDict[args[0]] + except KeyError: + func = lambda args, c, t, dict: [] + return func(args[1:], c, t, dict) + + +def create_scons_output(e): + # The real raison d'etre for this script, this is where we + # actually execute SCons to fetch the output. + + # Loop over all outputs for the example + for o in e.outputs: + # Create new test directory + t = TestCmd.TestCmd(workdir='', combine=1) + if o.preserve: + t.preserve() + t.subdir('ROOT', 'WORK') + t.rootpath = t.workpath('ROOT').replace('\\', '\\\\') + + for d in e.folders: + dir = t.workpath('WORK', d.name) + if not os.path.exists(dir): + os.makedirs(dir) + + for f in e.files: + if f.isFileRef(): + continue + # + # Left-align file's contents, starting on the first + # non-empty line + # + data = f.content.split('\n') + i = 0 + # Skip empty lines + while data[i] == '': + i = i + 1 + lines = data[i:] + i = 0 + # Scan first line for the number of spaces + # that this block is indented + while lines[0][i] == ' ': + i = i + 1 + # Left-align block + lines = [l[i:] for l in lines] + path = f.name.replace('__ROOT__', t.rootpath) + if not os.path.isabs(path): + path = t.workpath('WORK', path) + dir, name = os.path.split(path) + if dir and not os.path.exists(dir): + os.makedirs(dir) + content = '\n'.join(lines) + content = content.replace('__ROOT__', t.rootpath) + path = t.workpath('WORK', path) + t.write(path, content) + if hasattr(f, 'chmod'): + if len(f.chmod): + os.chmod(path, int(f.chmod, 0)) + + # Regular expressions for making the doc output consistent, + # regardless of reported addresses or Python version. + + # Massage addresses in object repr strings to a constant. + address_re = re.compile(r' at 0x[0-9a-fA-F]*\>') + + # Massage file names in stack traces (sometimes reported as absolute + # paths) to a consistent relative path. + engine_re = re.compile(r' File ".*/src/engine/SCons/') + + # Python 2.5 changed the stack trace when the module is read + # from standard input from read "... line 7, in ?" to + # "... line 7, in <module>". + file_re = re.compile(r'^( *File ".*", line \d+, in) \?$', re.M) + + # Python 2.6 made UserList a new-style class, which changes the + # AttributeError message generated by our NodeList subclass. + nodelist_re = re.compile(r'(AttributeError:) NodeList instance (has no attribute \S+)') + + # Root element for our subtree + sroot = stf.newEtreeNode("screen", True) + curchild = None + content = "" + for c in o.commands: + content += Prompt[o.os] + if curchild is not None: + if not c.output: + # Append content as tail + curchild.tail = content + content = "\n" + # Add new child for userinput tag + curchild = stf.newEtreeNode("userinput") + d = c.cmd.replace('__ROOT__', '') + curchild.text = d + sroot.append(curchild) + else: + content += c.output + '\n' + else: + if not c.output: + # Add first text to root + sroot.text = content + content = "\n" + # Add new child for userinput tag + curchild = stf.newEtreeNode("userinput") + d = c.cmd.replace('__ROOT__', '') + curchild.text = d + sroot.append(curchild) + else: + content += c.output + '\n' + # Execute command and capture its output + cmd_work = c.cmd.replace('__ROOT__', t.workpath('ROOT')) + args = cmd_work.split() + lines = ExecuteCommand(args, c, t, {'osname':o.os, 'tools':o.tools}) + if not c.output and lines: + ncontent = '\n'.join(lines) + ncontent = address_re.sub(r' at 0x700000>', ncontent) + ncontent = engine_re.sub(r' File "bootstrap/src/engine/SCons/', ncontent) + ncontent = file_re.sub(r'\1 <module>', ncontent) + ncontent = nodelist_re.sub(r"\1 'NodeList' object \2", ncontent) + ncontent = ncontent.replace('__ROOT__', '') + content += ncontent + '\n' + # Add last piece of content + if len(content): + if curchild is not None: + curchild.tail = content + else: + sroot.text = content + + # Construct filename + fpath = os.path.join(generated_examples, + e.name+'_'+o.suffix+'.xml') + # Expand Element tree + s = stf.decorateWithCommentHeader(stf.convertElementTree(sroot)[0]) + # Write it to file + stf.writeTree(s, fpath) + + # Local Variables: # tab-width:4 # indent-tabs-mode:nil diff --git a/bin/scons-doc.py b/bin/scons-doc.py index ff06c043..95da5f30 100644 --- a/bin/scons-doc.py +++ b/bin/scons-doc.py @@ -22,31 +22,11 @@ # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. # -# scons-doc.py - an SGML preprocessor for capturing SCons output -# and inserting it into examples in our DocBook -# documentation # -# Synopsis: -# -# scons-doc [OPTIONS] [.in files] -# -# When no input files are given, the folder doc/user/* is searched for .in files. -# -# Available options: -# -# -d, --diff create examples for the .in file and output a unified -# diff against the related .xml file -# -r, --run create examples for the .in file, but do not change -# any files -# -s, --simple_diff use a simpler output for the diff mode (no unified -# diff!) -# -u, --update create examples for the .in file and update the -# related .xml file -# -# This script looks for some SGML tags that describe SCons example +# This script looks for some XML tags that describe SCons example # configurations and commands to execute in those configurations, and # uses TestCmd.py to execute the commands and insert the output from -# those commands into the SGML that we output. This way, we can run a +# those commands into the XML that we output. This way, we can run a # script and update all of our example documentation output without # a lot of laborious by-hand checking. # @@ -89,8 +69,8 @@ # SCons output is generated from the following sort of tag: # # <scons_output example="ex1" os="posix"> -# <scons_output_command>scons -Q foo</scons_output_command> -# <scons_output_command>scons -Q foo</scons_output_command> +# <scons_output_command suffix="1">scons -Q foo</scons_output_command> +# <scons_output_command suffix="2">scons -Q foo</scons_output_command> # </scons_output> # # You tell it which example to use with the "example" attribute, and then @@ -98,7 +78,7 @@ # supply an "os" tag, which specifies the type of operating system this # example is intended to show; if you omit this, default value is "posix". # -# The generated SGML will show the command line (with the appropriate +# The generated XML will show the command line (with the appropriate # command-line prompt for the operating system), execute the command in # a temporary directory with the example files, capture the standard # output from SCons, and insert it into the text as appropriate. @@ -106,13 +86,10 @@ # can see if there are any problems executing the command. # -import optparse import os import re -import sgmllib import sys import time -import glob sys.path.append(os.path.join(os.getcwd(), 'QMTest')) sys.path.append(os.path.join(os.getcwd(), 'build', 'QMTest')) @@ -129,56 +106,6 @@ os.environ['SCONS_LIB_DIR'] = scons_lib_dir import TestCmd -# The regular expression that identifies entity references in the -# standard sgmllib omits the underscore from the legal characters. -# Override it with our own regular expression that adds underscore. -sgmllib.entityref = re.compile('&([a-zA-Z][-_.a-zA-Z0-9]*)[^-_a-zA-Z0-9]') - -# Classes for collecting different types of data we're interested in. -class DataCollector(object): - """Generic class for collecting data between a start tag and end - tag. We subclass for various types of tags we care about.""" - def __init__(self): - self.data = "" - def afunc(self, data): - self.data = self.data + data - -class Example(DataCollector): - """An SCons example. This is essentially a list of files that - will get written to a temporary directory to collect output - from one or more SCons runs.""" - def __init__(self): - DataCollector.__init__(self) - self.files = [] - self.dirs = [] - -class File(DataCollector): - """A file, that will get written out to a temporary directory - for one or more SCons runs.""" - def __init__(self, name): - DataCollector.__init__(self) - self.name = name - -class Directory(DataCollector): - """A directory, that will get created in a temporary directory - for one or more SCons runs.""" - def __init__(self, name): - DataCollector.__init__(self) - self.name = name - -class Output(DataCollector): - """Where the command output goes. This is essentially - a list of commands that will get executed.""" - def __init__(self): - DataCollector.__init__(self) - self.commandlist = [] - -class Command(DataCollector): - """A tag for where the command output goes. This is essentially - a list of commands that will get executed.""" - def __init__(self): - DataCollector.__init__(self) - self.output = None Prompt = { 'posix' : '% ', @@ -517,115 +444,51 @@ def ExecuteCommand(args, c, t, dict): func = lambda args, c, t, dict: [] return func(args[1:], c, t, dict) -class MySGML(sgmllib.SGMLParser): - """A subclass of the standard Python sgmllib SGML parser. - - This extends the standard sgmllib parser to recognize, and do cool - stuff with, the added tags that describe our SCons examples, - commands, and other stuff. - """ - def __init__(self, outfp): - sgmllib.SGMLParser.__init__(self) - self.examples = {} - self.afunclist = [] - self.outfp = outfp - - # The first set of methods here essentially implement pass-through - # handling of most of the stuff in an SGML file. We're really - # only concerned with the tags specific to SCons example processing, - # the methods for which get defined below. - - def handle_data(self, data): - try: - f = self.afunclist[-1] - except IndexError: - self.outfp.write(data) - else: - f(data) - def handle_comment(self, data): - self.outfp.write('<!--' + data + '-->') +def for_display(contents): + contents = contents.replace('__ROOT__', '') + contents = contents.replace('<', '<') + contents = contents.replace('>', '>') + return contents - def handle_decl(self, data): - self.outfp.write('<!' + data + '>') - def unknown_starttag(self, tag, attrs): - try: - f = self.example.afunc - except AttributeError: - f = self.outfp.write - if not attrs: - f('<' + tag + '>') - else: - f('<' + tag) - for name, value in attrs: - f(' ' + name + '=' + '"' + value + '"') - f('>') - - def unknown_endtag(self, tag): - self.outfp.write('</' + tag + '>') - - def unknown_entityref(self, ref): - self.outfp.write('&' + ref + ';') - - def unknown_charref(self, ref): - self.outfp.write('&#' + ref + ';') - - # Here is where the heavy lifting begins. The following methods - # handle the begin-end tags of our SCons examples. - - def for_display(self, contents): - contents = contents.replace('__ROOT__', '') - contents = contents.replace('<', '<') - contents = contents.replace('>', '>') - return contents - - - def start_scons_output(self, attrs): - t = [t for t in attrs if t[0] == 'example'] - if not t: - self.error("no <scons_output> example attribute found") - exname = t[0][1] - try: - e = self.examples[exname] - except KeyError: - self.error("unknown example name '%s'" % exname) - # Default values for an example. - o = Output() - o.preserve = None - o.os = 'posix' - o.tools = '' - o.e = e - # Locally-set. - for name, value in attrs: - setattr(o, name, value) - self.o = o - self.afunclist.append(o.afunc) - - def end_scons_output(self): - # The real raison d'etre for this script, this is where we - # actually execute SCons to fetch the output. - o = self.o - e = o.e +def create_scons_output(e): + # The real raison d'etre for this script, this is where we + # actually execute SCons to fetch the output. + + # Loop over all outputs for the example + for o in e.outputs: + # Create new test directory t = TestCmd.TestCmd(workdir='', combine=1) if o.preserve: t.preserve() t.subdir('ROOT', 'WORK') t.rootpath = t.workpath('ROOT').replace('\\', '\\\\') - + for d in e.dirs: dir = t.workpath('WORK', d.name) if not os.path.exists(dir): os.makedirs(dir) - + for f in e.files: + if f.isFileRef(): + continue + # + # Left-align file's contents, starting on the first + # non-empty line + # + data = f.content.split('\n') i = 0 - while f.data[i] == '\n': + # Skip empty lines + while data[i] == '': i = i + 1 - lines = f.data[i:].split('\n') + lines = data[i:] i = 0 + # Scan first line for the number of spaces + # that this block is indented while lines[0][i] == ' ': i = i + 1 + # Left-align block lines = [l[i:] for l in lines] path = f.name.replace('__ROOT__', t.rootpath) if not os.path.isabs(path): @@ -639,89 +502,52 @@ class MySGML(sgmllib.SGMLParser): t.write(path, content) if hasattr(f, 'chmod'): os.chmod(path, int(f.chmod, 0)) - - i = len(o.prefix) - while o.prefix[i-1] != '\n': - i = i - 1 - - self.outfp.write('<screen>' + o.prefix[:i]) - p = o.prefix[i:] - + # Regular expressions for making the doc output consistent, # regardless of reported addresses or Python version. - + # Massage addresses in object repr strings to a constant. address_re = re.compile(r' at 0x[0-9a-fA-F]*\>') - + # Massage file names in stack traces (sometimes reported as absolute # paths) to a consistent relative path. engine_re = re.compile(r' File ".*/src/engine/SCons/') - + # Python 2.5 changed the stack trace when the module is read # from standard input from read "... line 7, in ?" to # "... line 7, in <module>". file_re = re.compile(r'^( *File ".*", line \d+, in) \?$', re.M) - + # Python 2.6 made UserList a new-style class, which changes the # AttributeError message generated by our NodeList subclass. nodelist_re = re.compile(r'(AttributeError:) NodeList instance (has no attribute \S+)') - + for c in o.commandlist: - self.outfp.write(p + Prompt[o.os]) - d = c.data.replace('__ROOT__', '') - self.outfp.write('<userinput>' + d + '</userinput>\n') - - e = c.data.replace('__ROOT__', t.workpath('ROOT')) - args = e.split() + # Open new output file + fpath = os.path.join(SConsExamples.generated_examples, + e.name+'_'+c.suffix+'.out','w') + outfp = open(fpath) + outfp.write(Prompt[o.os]) + d = c.cmd.replace('__ROOT__', '') + outfp.write('<userinput>' + d + '</userinput>\n') + + cmd_work = c.cmd.replace('__ROOT__', t.workpath('ROOT')) + args = cmd_work.split() lines = ExecuteCommand(args, c, t, {'osname':o.os, 'tools':o.tools}) content = None if c.output: content = c.output elif lines: - content = ( '\n' + p).join(lines) + content = '\n'.join(lines) if content: content = address_re.sub(r' at 0x700000>', content) content = engine_re.sub(r' File "bootstrap/src/engine/SCons/', content) content = file_re.sub(r'\1 <module>', content) content = nodelist_re.sub(r"\1 'NodeList' object \2", content) - content = self.for_display(content) - self.outfp.write(p + content + '\n') - - if o.data[0] == '\n': - o.data = o.data[1:] - self.outfp.write(o.data + '</screen>') - delattr(self, 'o') - self.afunclist = self.afunclist[:-1] - - def start_scons_output_command(self, attrs): - try: - o = self.o - except AttributeError: - self.error("<scons_output_command> tag outside of <scons_output>") - try: - o.prefix - except AttributeError: - o.prefix = o.data - o.data = "" - c = Command() - for name, value in attrs: - setattr(c, name, value) - o.commandlist.append(c) - self.afunclist.append(c.afunc) - - def end_scons_output_command(self): - self.o.data = "" - self.afunclist = self.afunclist[:-1] - - - -def main(): - argv = sys.argv - - -if __name__ == "__main__": - sys.exit(main()) - + content = for_display(content) + outfp.write(content + '\n') + outfp.close() + # Local Variables: # tab-width:4 # indent-tabs-mode:nil diff --git a/doc/user/add-method.xml b/doc/user/add-method.xml index aeb85cf9..f15ba22b 100644 --- a/doc/user/add-method.xml +++ b/doc/user/add-method.xml @@ -81,8 +81,8 @@ This produces the following: </para> - <scons_output example="addmethod_ex1"> - <scons_output_command suffix="1">scons -Q /</scons_output_command> + <scons_output example="addmethod_ex1" suffix="1"> + <scons_output_command>scons -Q /</scons_output_command> </scons_output> <para> @@ -98,7 +98,7 @@ </para> - <scons_example name="ex2"> + <scons_example name="addmethod_ex2"> <file name="SConstruct" printme="1"> def BuildTestProg(env, testfile, resourcefile, testdir="tests"): """Build the test program; @@ -129,16 +129,16 @@ This produces the following on Linux: </para> - <scons_output example="ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="addmethod_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> And the following on Windows: </para> - <scons_output example="ex2" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="addmethod_ex2" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/alias.xml b/doc/user/alias.xml index 07c5bbdc..32f585f6 100644 --- a/doc/user/alias.xml +++ b/doc/user/alias.xml @@ -71,8 +71,8 @@ </para> - <scons_output example="alias_ex1" os="posix"> - <scons_output_command suffix="1">scons -Q install</scons_output_command> + <scons_output example="alias_ex1" os="posix" suffix="1"> + <scons_output_command>scons -Q install</scons_output_command> </scons_output> <para> @@ -116,11 +116,11 @@ </para> - <scons_output example="alias_ex2" os="posix"> - <scons_output_command suffix="1">scons -Q install-bin</scons_output_command> - <scons_output_command suffix="2">scons -Q install-lib</scons_output_command> - <scons_output_command suffix="3">scons -Q -c __ROOT__/</scons_output_command> - <scons_output_command suffix="4">scons -Q install</scons_output_command> + <scons_output example="alias_ex2" os="posix" suffix="1"> + <scons_output_command>scons -Q install-bin</scons_output_command> + <scons_output_command>scons -Q install-lib</scons_output_command> + <scons_output_command>scons -Q -c __ROOT__/</scons_output_command> + <scons_output_command>scons -Q install</scons_output_command> </scons_output> </chapter> diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index 1f1d525f..c5ae6a4e 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -1,5 +1,9 @@ <?xml version='1.0'?> <!DOCTYPE sconsdoc [ + + <!ENTITY % version SYSTEM "../version.xml"> + %version; + <!ENTITY % scons SYSTEM "../scons.mod"> %scons; @@ -221,7 +225,7 @@ </para> <screen> - # <userinput>rpm -Uvh scons-__VERSION__-1.noarch.rpm</userinput> + # <userinput>rpm -Uvh scons-&buildversion;-1.noarch.rpm</userinput> </screen> <para> @@ -283,7 +287,7 @@ &SCons; provides a Windows installer that makes installation extremely easy. - Download the <filename>scons-__VERSION__.win32.exe</filename> + Download the <filename>scons-&buildversion;.win32.exe</filename> file from the &SCons; download page at <ulink url="http://www.scons.org/download.php">http://www.scons.org/download.php</ulink>. Then all you need to do is execute the file @@ -393,8 +397,8 @@ <para> The first step is to download either the - <filename>scons-__VERSION__.tar.gz</filename> - or <filename>scons-__VERSION__.zip</filename>, + <filename>scons-&buildversion;.tar.gz</filename> + or <filename>scons-&buildversion;.zip</filename>, which are available from the SCons download page at <ulink url="http://www.scons.org/download.html">http://www.scons.org/download.html</ulink>. @@ -407,7 +411,7 @@ on Linux or UNIX, or <application>WinZip</application> on Windows. This will create a directory called - <filename>scons-__VERSION__</filename>, + <filename>scons-&buildversion;</filename>, usually in your local directory. Then change your working directory to that directory and install &SCons; by executing the following commands: @@ -415,7 +419,7 @@ </para> <screen> - # <userinput>cd scons-__VERSION__</userinput> + # <userinput>cd scons-&buildversion;</userinput> # <userinput>python setup.py install</userinput> </screen> @@ -483,9 +487,9 @@ This will install the &SCons; build engine in the - <filename>/usr/lib/scons-__VERSION__</filename> + <filename>/usr/lib/scons-&buildversion;</filename> or - <filename>C:\Python25\scons-__VERSION__</filename> + <filename>C:\Python25\scons-&buildversion;</filename> directory, for example. </para> @@ -542,7 +546,7 @@ relative to the specified prefix. Adding <option>--version-lib</option> to the above example would install the build engine in - <filename>/opt/scons/lib/scons-__VERSION__</filename>. + <filename>/opt/scons/lib/scons-&buildversion;</filename>. </para> diff --git a/doc/user/builders-built-in.xml b/doc/user/builders-built-in.xml index 6b47afc2..37e78955 100644 --- a/doc/user/builders-built-in.xml +++ b/doc/user/builders-built-in.xml @@ -172,8 +172,8 @@ </para> - <scons_output example="buildersbuiltin_libs" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="buildersbuiltin_libs" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -182,8 +182,8 @@ </para> - <scons_output example="buildersbuiltin_libs" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="buildersbuiltin_libs" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -760,8 +760,8 @@ </file> </scons_example> - <scons_output example="buildersbuiltin_ex1" os="posix"> - <scons_output_command suffix="1">scons -Q .</scons_output_command> + <scons_output example="buildersbuiltin_ex1" os="posix" suffix="1"> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> <para> @@ -789,8 +789,8 @@ </file> </scons_example> - <scons_output example="buildersbuiltin_ex2" os="posix"> - <scons_output_command suffix="1">scons -Q .</scons_output_command> + <scons_output example="buildersbuiltin_ex2" os="posix" suffix="1"> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> <para> @@ -814,8 +814,8 @@ </file> </scons_example> - <scons_output example="buildersbuiltin_ex3" os="posix"> - <scons_output_command suffix="1">scons -Q .</scons_output_command> + <scons_output example="buildersbuiltin_ex3" os="posix" suffix="1"> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> </section> @@ -856,8 +856,8 @@ </para> - <scons_output example="buildersbuiltin_ex4" os="posix"> - <scons_output_command suffix="1">scons -Q .</scons_output_command> + <scons_output example="buildersbuiltin_ex4" os="posix" suffix="1"> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> </section> diff --git a/doc/user/builders-commands.xml b/doc/user/builders-commands.xml index f9583ca0..2c99e948 100644 --- a/doc/user/builders-commands.xml +++ b/doc/user/builders-commands.xml @@ -110,8 +110,8 @@ </para> - <scons_output example="builderscommands_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderscommands_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -150,8 +150,8 @@ </para> - <scons_output example="builderscommands_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderscommands_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/builders-writing.xml b/doc/user/builders-writing.xml index e676ef2b..d621929a 100644 --- a/doc/user/builders-writing.xml +++ b/doc/user/builders-writing.xml @@ -224,8 +224,8 @@ This functionality could be invoked as in the following example: </para> - <scons_output example="builderswriting_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -280,8 +280,8 @@ This functionality could be invoked as in the following example: </file> </scons_example> - <scons_output example="builderswriting_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -346,8 +346,8 @@ This functionality could be invoked as in the following example: </para> - <scons_output example="builderswriting_ex3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -403,8 +403,8 @@ This functionality could be invoked as in the following example: env.Foo('file2') </sconstruct> - <scons_output example="builderswriting_ex4"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex4" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -544,8 +544,8 @@ This functionality could be invoked as in the following example: </para> - <scons_output example="builderswriting_ex5"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex5" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -696,8 +696,8 @@ This functionality could be invoked as in the following example: env.Foo('file') </sconstruct> - <scons_output example="builderswriting_ex6"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex6" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -789,8 +789,8 @@ This functionality could be invoked as in the following example: </para> - <scons_output example="builderswriting_ex7"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex7" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -874,8 +874,8 @@ This functionality could be invoked as in the following example: </para> - <scons_output example="builderswriting_MY_EMITTER"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_MY_EMITTER" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -999,8 +999,8 @@ This functionality could be invoked as in the following example: </para> <!-- - <scons_output example="builderswriting_site1" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_site1" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -1121,8 +1121,8 @@ This functionality could be invoked as in the following example: </file> </scons_example> - <scons_output example="builderswriting_ex8"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="builderswriting_ex8" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> diff --git a/doc/user/caching.xml b/doc/user/caching.xml index 522dd65a..ff8d0e3b 100644 --- a/doc/user/caching.xml +++ b/doc/user/caching.xml @@ -120,10 +120,10 @@ </para> - <scons_output example="caching_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q -c</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> + <scons_output example="caching_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -170,10 +170,10 @@ </para> - <scons_output example="caching_ex1"> - <scons_output_command suffix="4">scons -Q</scons_output_command> - <scons_output_command suffix="5">scons -Q -c</scons_output_command> - <scons_output_command suffix="6">scons -Q --cache-show</scons_output_command> + <scons_output example="caching_ex1" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q --cache-show</scons_output_command> </scons_output> <para> @@ -232,10 +232,10 @@ <!-- - <scons_output example="caching_ex1"> - <scons_output_command suffix="7">scons -Q</scons_output_command> - <scons_output_command suffix="8">scons -Q -c</scons_output_command> - <scons_output_command suffix="9">scons -Q</scons_output_command> + <scons_output example="caching_ex1" suffix="3"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -284,12 +284,12 @@ </para> - <scons_output example="caching_ex1"> - <scons_output_command suffix="10">scons -Q</scons_output_command> - <scons_output_command suffix="11">scons -Q -c</scons_output_command> - <scons_output_command suffix="12">scons -Q</scons_output_command> - <scons_output_command suffix="13">scons -Q -c</scons_output_command> - <scons_output_command suffix="14">scons -Q --cache-disable</scons_output_command> + <scons_output example="caching_ex1" suffix="4"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q --cache-disable</scons_output_command> </scons_output> </section> @@ -325,12 +325,12 @@ </para> - <scons_output example="caching_ex1"> - <scons_output_command suffix="15">scons -Q --cache-disable</scons_output_command> - <scons_output_command suffix="16">scons -Q -c</scons_output_command> - <scons_output_command suffix="17">scons -Q --cache-disable</scons_output_command> - <scons_output_command suffix="18">scons -Q --cache-force</scons_output_command> - <scons_output_command suffix="19">scons -Q</scons_output_command> + <scons_output example="caching_ex1" suffix="5"> + <scons_output_command>scons -Q --cache-disable</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q --cache-disable</scons_output_command> + <scons_output_command>scons -Q --cache-force</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -385,8 +385,8 @@ </para> - <scons_output example="caching_ex-random"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="caching_ex-random" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -420,8 +420,8 @@ The following <screen> output was generated by this: - <scons_output example="caching_ex-random"> - <scons_output_command suffix="2">scons -Q - -random</scons_output_command> + <scons_output example="caching_ex-random" suffix="2"> + <scons_output_command>scons -Q - -random</scons_output_command> </scons_output> We captured it directly here to guarantee a "random" order, diff --git a/doc/user/command-line.xml b/doc/user/command-line.xml index ba08bf95..55545b42 100644 --- a/doc/user/command-line.xml +++ b/doc/user/command-line.xml @@ -183,10 +183,10 @@ </file> </scons_example> - <scons_output example="commandline_SCONSFLAGS"> - <scons_output_command suffix="1">scons</scons_output_command> - <scons_output_command suffix="2">export SCONSFLAGS="-Q"</scons_output_command> - <scons_output_command environment="SCONSFLAGS=-Q" suffix="3">scons</scons_output_command> + <scons_output example="commandline_SCONSFLAGS" suffix="1"> + <scons_output_command>scons</scons_output_command> + <scons_output_command>export SCONSFLAGS="-Q"</scons_output_command> + <scons_output_command environment="SCONSFLAGS=-Q">scons</scons_output_command> </scons_output> <para> @@ -344,8 +344,8 @@ </para> - <scons_output example="commandline_SetOption"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="commandline_SetOption" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -356,9 +356,9 @@ </para> - <scons_output example="commandline_SetOption"> - <scons_output_command suffix="2">export NUM_CPU="4"</scons_output_command> - <scons_output_command environment="NUM_CPU=4" suffix="3">scons -Q</scons_output_command> + <scons_output example="commandline_SetOption" suffix="2"> + <scons_output_command>export NUM_CPU="4"</scons_output_command> + <scons_output_command environment="NUM_CPU=4">scons -Q</scons_output_command> </scons_output> <para> @@ -372,10 +372,10 @@ </para> - <scons_output example="commandline_SetOption"> - <scons_output_command suffix="4">scons -Q -j 7</scons_output_command> - <scons_output_command suffix="5">export NUM_CPU="4"</scons_output_command> - <scons_output_command environment="NUM_CPU=4" suffix="6">scons -Q -j 3</scons_output_command> + <scons_output example="commandline_SetOption" suffix="3"> + <scons_output_command>scons -Q -j 7</scons_output_command> + <scons_output_command>export NUM_CPU="4"</scons_output_command> + <scons_output_command environment="NUM_CPU=4">scons -Q -j 3</scons_output_command> </scons_output> </section> @@ -662,8 +662,8 @@ </para> - <scons_output example="commandline_AddOption"> - <scons_output_command suffix="1">scons -Q -n</scons_output_command> + <scons_output example="commandline_AddOption" suffix="1"> + <scons_output_command>scons -Q -n</scons_output_command> </scons_output> <para> @@ -674,8 +674,8 @@ </para> - <scons_output example="commandline_AddOption"> - <scons_output_command suffix="2">scons -Q -n --prefix=/tmp/install</scons_output_command> + <scons_output example="commandline_AddOption" suffix="2"> + <scons_output_command>scons -Q -n --prefix=/tmp/install</scons_output_command> </scons_output> </section> @@ -753,11 +753,11 @@ </para> - <scons_output example="commandline_ARGUMENTS"> - <scons_output_command suffix="1">scons -Q debug=0</scons_output_command> - <scons_output_command suffix="2">scons -Q debug=0</scons_output_command> - <scons_output_command suffix="3">scons -Q debug=1</scons_output_command> - <scons_output_command suffix="4">scons -Q debug=1</scons_output_command> + <scons_output example="commandline_ARGUMENTS" suffix="1"> + <scons_output_command>scons -Q debug=0</scons_output_command> + <scons_output_command>scons -Q debug=0</scons_output_command> + <scons_output_command>scons -Q debug=1</scons_output_command> + <scons_output_command>scons -Q debug=1</scons_output_command> </scons_output> <para> @@ -840,9 +840,9 @@ </para> - <scons_output example="commandline_ARGLIST"> - <scons_output_command suffix="1">scons -Q define=FOO</scons_output_command> - <scons_output_command suffix="2">scons -Q define=FOO define=BAR</scons_output_command> + <scons_output example="commandline_ARGLIST" suffix="1"> + <scons_output_command>scons -Q define=FOO</scons_output_command> + <scons_output_command>scons -Q define=FOO define=BAR</scons_output_command> </scons_output> <para> @@ -950,8 +950,8 @@ </para> - <scons_output example="commandline_Variables1"> - <scons_output_command suffix="1">scons -Q RELEASE=1</scons_output_command> + <scons_output example="commandline_Variables1" suffix="1"> + <scons_output_command>scons -Q RELEASE=1</scons_output_command> </scons_output> <para> @@ -1012,8 +1012,8 @@ </para> - <scons_output example="commandline_Variables_Help"> - <scons_output_command suffix="1">scons -Q -h</scons_output_command> + <scons_output example="commandline_Variables_Help" suffix="1"> + <scons_output_command>scons -Q -h</scons_output_command> </scons_output> <para> @@ -1080,8 +1080,8 @@ </para> - <scons_output example="commandline_Variables_custom_py_1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="commandline_Variables_custom_py_1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1117,8 +1117,8 @@ </para> - <scons_output example="commandline_Variables_custom_py_2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="commandline_Variables_custom_py_2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1202,12 +1202,12 @@ </para> - <scons_output example="commandline_BoolVariable"> - <scons_output_command suffix="1">scons -Q RELEASE=yes foo.o</scons_output_command> + <scons_output example="commandline_BoolVariable" suffix="1"> + <scons_output_command>scons -Q RELEASE=yes foo.o</scons_output_command> </scons_output> - <scons_output example="commandline_BoolVariable"> - <scons_output_command suffix="2">scons -Q RELEASE=t foo.o</scons_output_command> + <scons_output example="commandline_BoolVariable" suffix="2"> + <scons_output_command>scons -Q RELEASE=t foo.o</scons_output_command> </scons_output> <para> @@ -1231,12 +1231,12 @@ </para> - <scons_output example="commandline_BoolVariable"> - <scons_output_command suffix="3">scons -Q RELEASE=no foo.o</scons_output_command> + <scons_output example="commandline_BoolVariable" suffix="3"> + <scons_output_command>scons -Q RELEASE=no foo.o</scons_output_command> </scons_output> - <scons_output example="commandline_BoolVariable"> - <scons_output_command suffix="4">scons -Q RELEASE=f foo.o</scons_output_command> + <scons_output example="commandline_BoolVariable" suffix="4"> + <scons_output_command>scons -Q RELEASE=f foo.o</scons_output_command> </scons_output> <para> @@ -1258,8 +1258,8 @@ </para> - <scons_output example="commandline_BoolVariable"> - <scons_output_command suffix="5">scons -Q RELEASE=bad_value foo.o</scons_output_command> + <scons_output example="commandline_BoolVariable" suffix="5"> + <scons_output_command>scons -Q RELEASE=bad_value foo.o</scons_output_command> </scons_output> </section> @@ -1305,10 +1305,10 @@ </para> - <scons_output example="commandline_EnumVariable"> - <scons_output_command suffix="1">scons -Q COLOR=red foo.o</scons_output_command> - <scons_output_command suffix="2">scons -Q COLOR=blue foo.o</scons_output_command> - <scons_output_command suffix="3">scons -Q COLOR=green foo.o</scons_output_command> + <scons_output example="commandline_EnumVariable" suffix="1"> + <scons_output_command>scons -Q COLOR=red foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=blue foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=green foo.o</scons_output_command> </scons_output> <para> @@ -1320,8 +1320,8 @@ </para> - <scons_output example="commandline_EnumVariable"> - <scons_output_command suffix="4">scons -Q COLOR=magenta foo.o</scons_output_command> + <scons_output example="commandline_EnumVariable" suffix="2"> + <scons_output_command>scons -Q COLOR=magenta foo.o</scons_output_command> </scons_output> <para> @@ -1363,8 +1363,8 @@ </para> - <scons_output example="EnumVariable_map"> - <scons_output_command suffix="1">scons -Q COLOR=navy foo.o</scons_output_command> + <scons_output example="EnumVariable_map" suffix="1"> + <scons_output_command>scons -Q COLOR=navy foo.o</scons_output_command> </scons_output> <para> @@ -1377,10 +1377,10 @@ </para> - <scons_output example="commandline_EnumVariable"> - <scons_output_command suffix="5">scons -Q COLOR=Red foo.o</scons_output_command> - <scons_output_command suffix="6">scons -Q COLOR=BLUE foo.o</scons_output_command> - <scons_output_command suffix="7">scons -Q COLOR=nAvY foo.o</scons_output_command> + <scons_output example="commandline_EnumVariable" suffix="3"> + <scons_output_command>scons -Q COLOR=Red foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=BLUE foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=nAvY foo.o</scons_output_command> </scons_output> <para> @@ -1415,11 +1415,11 @@ </para> - <scons_output example="commandline_EnumVariable_ic1"> - <scons_output_command suffix="1">scons -Q COLOR=Red foo.o</scons_output_command> - <scons_output_command suffix="2">scons -Q COLOR=BLUE foo.o</scons_output_command> - <scons_output_command suffix="3">scons -Q COLOR=nAvY foo.o</scons_output_command> - <scons_output_command suffix="4">scons -Q COLOR=green foo.o</scons_output_command> + <scons_output example="commandline_EnumVariable_ic1" suffix="1"> + <scons_output_command>scons -Q COLOR=Red foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=BLUE foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=nAvY foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=green foo.o</scons_output_command> </scons_output> <para> @@ -1460,10 +1460,10 @@ </para> - <scons_output example="commandline_EnumVariable_ic2"> - <scons_output_command suffix="1">scons -Q COLOR=Red foo.o</scons_output_command> - <scons_output_command suffix="2">scons -Q COLOR=nAvY foo.o</scons_output_command> - <scons_output_command suffix="3">scons -Q COLOR=GREEN foo.o</scons_output_command> + <scons_output example="commandline_EnumVariable_ic2" suffix="1"> + <scons_output_command>scons -Q COLOR=Red foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=nAvY foo.o</scons_output_command> + <scons_output_command>scons -Q COLOR=GREEN foo.o</scons_output_command> </scons_output> </section> @@ -1505,9 +1505,9 @@ </para> - <scons_output example="commandline_ListVariable"> - <scons_output_command suffix="1">scons -Q COLORS=red,blue foo.o</scons_output_command> - <scons_output_command suffix="2">scons -Q COLORS=blue,green,red foo.o</scons_output_command> + <scons_output example="commandline_ListVariable" suffix="1"> + <scons_output_command>scons -Q COLORS=red,blue foo.o</scons_output_command> + <scons_output_command>scons -Q COLORS=blue,green,red foo.o</scons_output_command> </scons_output> <para> @@ -1520,9 +1520,9 @@ </para> - <scons_output example="commandline_ListVariable"> - <scons_output_command suffix="3">scons -Q COLORS=all foo.o</scons_output_command> - <scons_output_command suffix="4">scons -Q COLORS=none foo.o</scons_output_command> + <scons_output example="commandline_ListVariable" suffix="2"> + <scons_output_command>scons -Q COLORS=all foo.o</scons_output_command> + <scons_output_command>scons -Q COLORS=none foo.o</scons_output_command> </scons_output> <para> @@ -1532,8 +1532,8 @@ </para> - <scons_output example="commandline_ListVariable"> - <scons_output_command suffix="5">scons -Q COLORS=magenta foo.o</scons_output_command> + <scons_output example="commandline_ListVariable" suffix="3"> + <scons_output_command>scons -Q COLORS=magenta foo.o</scons_output_command> </scons_output> </section> @@ -1582,9 +1582,9 @@ </para> - <scons_output example="commandline_PathVariable"> - <scons_output_command suffix="1">scons -Q foo.o</scons_output_command> - <scons_output_command suffix="2">scons -Q CONFIG=__ROOT__/usr/local/etc/other_config foo.o</scons_output_command> + <scons_output example="commandline_PathVariable" suffix="1"> + <scons_output_command>scons -Q foo.o</scons_output_command> + <scons_output_command>scons -Q CONFIG=__ROOT__/usr/local/etc/other_config foo.o</scons_output_command> </scons_output> <para> @@ -1595,8 +1595,8 @@ </para> - <scons_output example="commandline_PathVariable"> - <scons_output_command suffix="3">scons -Q CONFIG=__ROOT__/does/not/exist foo.o</scons_output_command> + <scons_output example="commandline_PathVariable" suffix="2"> + <scons_output_command>scons -Q CONFIG=__ROOT__/does/not/exist foo.o</scons_output_command> </scons_output> <para> @@ -1762,11 +1762,11 @@ </para> - <scons_output example="commandline_PackageVariable"> - <scons_output_command suffix="1">scons -Q foo.o</scons_output_command> - <scons_output_command suffix="2">scons -Q PACKAGE=__ROOT__/usr/local/location foo.o</scons_output_command> - <scons_output_command suffix="3">scons -Q PACKAGE=yes foo.o</scons_output_command> - <scons_output_command suffix="4">scons -Q PACKAGE=no foo.o</scons_output_command> + <scons_output example="commandline_PackageVariable" suffix="1"> + <scons_output_command>scons -Q foo.o</scons_output_command> + <scons_output_command>scons -Q PACKAGE=__ROOT__/usr/local/location foo.o</scons_output_command> + <scons_output_command>scons -Q PACKAGE=yes foo.o</scons_output_command> + <scons_output_command>scons -Q PACKAGE=no foo.o</scons_output_command> </scons_output> </section> @@ -1891,8 +1891,8 @@ </para> - <scons_output example="commandline_UnknownVariables"> - <scons_output_command suffix="1">scons -Q NOT_KNOWN=foo</scons_output_command> + <scons_output example="commandline_UnknownVariables" suffix="1"> + <scons_output_command>scons -Q NOT_KNOWN=foo</scons_output_command> </scons_output> <para> @@ -1966,9 +1966,9 @@ </para> - <scons_output example="commandline_COMMAND_LINE_TARGETS"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q bar</scons_output_command> + <scons_output example="commandline_COMMAND_LINE_TARGETS" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q bar</scons_output_command> </scons_output> <para> @@ -2028,10 +2028,10 @@ </para> - <scons_output example="commandline_Default1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">scons -Q goodbye</scons_output_command> + <scons_output example="commandline_Default1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q goodbye</scons_output_command> </scons_output> <para> @@ -2045,8 +2045,8 @@ </para> - <scons_output example="commandline_Default1"> - <scons_output_command suffix="4">scons -Q .</scons_output_command> + <scons_output example="commandline_Default1" suffix="2"> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> <para> @@ -2104,9 +2104,9 @@ </para> - <scons_output example="commandline_Default2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q .</scons_output_command> + <scons_output example="commandline_Default2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> <para> @@ -2146,10 +2146,10 @@ </para> - <scons_output example="commandline_Default3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">scons -Q .</scons_output_command> + <scons_output example="commandline_Default3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> <para> @@ -2182,9 +2182,9 @@ </para> - <scons_output example="commandline_Default4"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q .</scons_output_command> + <scons_output example="commandline_Default4" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q .</scons_output_command> </scons_output> <section> @@ -2227,8 +2227,8 @@ </para> - <scons_output example="commandline_DEFAULT_TARGETS_1"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="commandline_DEFAULT_TARGETS_1" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -2263,8 +2263,8 @@ </para> - <scons_output example="commandline_DEFAULT_TARGETS_2"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="commandline_DEFAULT_TARGETS_2" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -2356,10 +2356,10 @@ </para> - <scons_output example="commandline_BUILD_TARGETS_1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q prog2</scons_output_command> - <scons_output_command suffix="3">scons -Q -c .</scons_output_command> + <scons_output example="commandline_BUILD_TARGETS_1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q prog2</scons_output_command> + <scons_output_command>scons -Q -c .</scons_output_command> </scons_output> </section> diff --git a/doc/user/depends.xml b/doc/user/depends.xml index a5468dc1..8e1ae217 100644 --- a/doc/user/depends.xml +++ b/doc/user/depends.xml @@ -67,9 +67,9 @@ </file> </scons_example> - <scons_output example="depends_ex1" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="depends_ex1" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -83,9 +83,9 @@ </para> - <scons_output example="depends_ex1" os="posix"> - <scons_output_command suffix="3">scons -Q hello</scons_output_command> - <scons_output_command suffix="4">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" os="posix" suffix="2"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -135,10 +135,10 @@ </para> - <scons_output example="depends_ex1" os="posix"> - <scons_output_command suffix="5">scons -Q hello</scons_output_command> - <scons_output_command suffix="6">touch hello.c</scons_output_command> - <scons_output_command suffix="7">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" os="posix" suffix="3"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>touch hello.c</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -157,10 +157,10 @@ </para> - <scons_output example="depends_ex1" os="posix"> - <scons_output_command suffix="8">scons -Q hello</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF hello.c]" suffix="9">edit hello.c</scons_output_command> - <scons_output_command suffix="10">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" os="posix" suffix="4"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF hello.c]">edit hello.c</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -216,10 +216,10 @@ </para> - <scons_output example="depends_ex1" os="posix"> - <scons_output_command suffix="11">scons -Q hello</scons_output_command> - <scons_output_command output=" [CHANGE A COMMENT IN hello.c]" edit="STRIP CCCOM line" suffix="12">edit hello.c</scons_output_command> - <scons_output_command suffix="13">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" os="posix" suffix="5"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command output=" [CHANGE A COMMENT IN hello.c]" edit="STRIP CCCOM line">edit hello.c</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -286,10 +286,10 @@ </para> - <scons_output example="depends_newer" os="posix"> - <scons_output_command suffix="1">scons -Q hello.o</scons_output_command> - <scons_output_command suffix="2">touch hello.c</scons_output_command> - <scons_output_command suffix="3">scons -Q hello.o</scons_output_command> + <scons_output example="depends_newer" os="posix" suffix="1"> + <scons_output_command>scons -Q hello.o</scons_output_command> + <scons_output_command>touch hello.c</scons_output_command> + <scons_output_command>scons -Q hello.o</scons_output_command> </scons_output> <para> @@ -359,10 +359,10 @@ </para> - <scons_output example="depends_match" os="posix"> - <scons_output_command suffix="1">scons -Q hello.o</scons_output_command> - <scons_output_command suffix="2">touch -t 198901010000 hello.c</scons_output_command> - <scons_output_command suffix="3">scons -Q hello.o</scons_output_command> + <scons_output example="depends_match" os="posix" suffix="1"> + <scons_output_command>scons -Q hello.o</scons_output_command> + <scons_output_command>touch -t 198901010000 hello.c</scons_output_command> + <scons_output_command>scons -Q hello.o</scons_output_command> </scons_output> <para> @@ -420,12 +420,12 @@ output seems to get this wrong. Just in-line the output for now. - <scons_output example="depends_MD5-timestamp" os="posix"> - <scons_output_command suffix="1">scons -Q hello</scons_output_command> - <scons_output_command suffix="2">touch hello.c</scons_output_command> - <scons_output_command suffix="3">scons -Q hello</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF hello.c]" suffix="4">edit hello.c</scons_output_command> - <scons_output_command suffix="5">scons -Q hello</scons_output_command> + <scons_output example="depends_MD5-timestamp" os="posix" suffix="1"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>touch hello.c</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF hello.c]">edit hello.c</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> --> @@ -729,10 +729,10 @@ </para> - <scons_output example="depends_mixing" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">touch inc.h</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> + <scons_output example="depends_mixing" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>touch inc.h</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -997,11 +997,11 @@ </para> - <scons_output example="depends_include" os="posix"> - <scons_output_command suffix="1">scons -Q hello</scons_output_command> - <scons_output_command suffix="2">scons -Q hello</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF hello.h]" suffix="3">edit hello.h</scons_output_command> - <scons_output_command suffix="4">scons -Q hello</scons_output_command> + <scons_output example="depends_include" os="posix" suffix="1"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF hello.h]">edit hello.h</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -1062,8 +1062,8 @@ </para> - <scons_output example="depends_ex5" os="posix"> - <scons_output_command suffix="1">scons -Q hello</scons_output_command> + <scons_output example="depends_ex5" os="posix" suffix="1"> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -1072,8 +1072,8 @@ </para> - <scons_output example="depends_ex5" os="win32"> - <scons_output_command suffix="2">scons -Q hello.exe</scons_output_command> + <scons_output example="depends_ex5" os="win32" suffix="2"> + <scons_output_command>scons -Q hello.exe</scons_output_command> </scons_output> </section> @@ -1126,9 +1126,9 @@ </para> - <scons_output example="depends_ex1"> - <scons_output_command suffix="14">scons -Q --implicit-cache hello</scons_output_command> - <scons_output_command suffix="15">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" suffix="6"> + <scons_output_command>scons -Q --implicit-cache hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -1206,9 +1206,9 @@ </para> - <scons_output example="depends_ex1"> - <scons_output_command suffix="16">scons -Q --implicit-deps-changed hello</scons_output_command> - <scons_output_command suffix="17">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" suffix="7"> + <scons_output_command>scons -Q --implicit-deps-changed hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -1241,9 +1241,9 @@ </para> - <scons_output example="depends_ex1"> - <scons_output_command suffix="18">scons -Q --implicit-deps-unchanged hello</scons_output_command> - <scons_output_command suffix="19">scons -Q hello</scons_output_command> + <scons_output example="depends_ex1" suffix="8"> + <scons_output_command>scons -Q --implicit-deps-unchanged hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -1379,11 +1379,10 @@ </file> </scons_example> - <scons_output example="depends_macroinc" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command output=" [CHANGE CONTENTS OF foo.h]" - suffix="2">edit foo.h</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> + <scons_output example="depends_macroinc" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command output=" [CHANGE CONTENTS OF foo.h]">edit foo.h</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1438,11 +1437,10 @@ </file> </scons_example> - <scons_output example="depends_parsedep" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command output=" [CHANGE CONTENTS OF foo.h]" - suffix="2">edit foo.h</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> + <scons_output example="depends_parsedep" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command output=" [CHANGE CONTENTS OF foo.h]">edit foo.h</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1474,10 +1472,10 @@ </scons_example> <!-- - <scons_output example="depends_parsedeprebuild" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> + <scons_output example="depends_parsedeprebuild" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -1550,11 +1548,11 @@ <!-- XXX mention that you can use lists for target and source? --> <!-- - <scons_output example="depends_ignore"> - <scons_output_command suffix="1">scons -Q hello</scons_output_command> - <scons_output_command suffix="2">scons -Q hello</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF hello.h]" suffix="3">edit hello.h</scons_output_command> - <scons_output_command suffix="4">scons -Q hello</scons_output_command> + <scons_output example="depends_ignore" suffix="1"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF hello.h]">edit hello.h</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> XXX THIS EXAMPLE SHOULD BE UP-TO-DATE! XXX </scons_output> --> @@ -1620,10 +1618,10 @@ </file> </scons_example> - <scons_output example="depends_ignore_explicit" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q hello</scons_output_command> - <scons_output_command suffix="3">scons -Q hello</scons_output_command> + <scons_output example="depends_ignore_explicit" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> </section> @@ -1699,12 +1697,12 @@ </para> - <scons_output example="depends_no-Requires"> - <scons_output_command suffix="1">scons -Q hello</scons_output_command> - <scons_output_command suffix="2">sleep 1</scons_output_command> - <scons_output_command suffix="3">scons -Q hello</scons_output_command> - <scons_output_command suffix="4">sleep 1</scons_output_command> - <scons_output_command suffix="5">scons -Q hello</scons_output_command> + <scons_output example="depends_no-Requires" suffix="1"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>sleep 1</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>sleep 1</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> <para> @@ -1776,15 +1774,15 @@ </para> - <scons_output example="depends_Requires"> - <scons_output_command suffix="1">scons -Q hello</scons_output_command> - <scons_output_command suffix="2">sleep 1</scons_output_command> - <scons_output_command suffix="3">scons -Q hello</scons_output_command> - <scons_output_command suffix="4">sleep 1</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF hello.c]" suffix="5">edit hello.c</scons_output_command> - <scons_output_command suffix="6">scons -Q hello</scons_output_command> - <scons_output_command suffix="7">sleep 1</scons_output_command> - <scons_output_command suffix="8">scons -Q hello</scons_output_command> + <scons_output example="depends_Requires" suffix="1"> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>sleep 1</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>sleep 1</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF hello.c]">edit hello.c</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> + <scons_output_command>sleep 1</scons_output_command> + <scons_output_command>scons -Q hello</scons_output_command> </scons_output> </section> @@ -1820,9 +1818,9 @@ </para> - <scons_output example="depends_AlwaysBuild"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="depends_AlwaysBuild" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1842,9 +1840,9 @@ </para> - <scons_output example="depends_AlwaysBuild"> - <scons_output_command suffix="3">scons -Q</scons_output_command> - <scons_output_command suffix="4">scons -Q hello.o</scons_output_command> + <scons_output example="depends_AlwaysBuild" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q hello.o</scons_output_command> </scons_output> <!-- diff --git a/doc/user/environments.xml b/doc/user/environments.xml index ad810dd1..4d6208eb 100644 --- a/doc/user/environments.xml +++ b/doc/user/environments.xml @@ -607,8 +607,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -639,8 +639,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex6"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex6" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -670,8 +670,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex6b" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex6b" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -680,8 +680,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex6b" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="environments_ex6b" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -810,8 +810,8 @@ environment, of directory names, suffixes, etc. </file> </scons_example> - <scons_output example="environments_missing1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_missing1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -838,8 +838,8 @@ environment, of directory names, suffixes, etc. </file> </scons_example> - <scons_output example="environments_missing2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_missing2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -858,8 +858,8 @@ environment, of directory names, suffixes, etc. </file> </scons_example> - <scons_output example="environments_missing3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_missing3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <sconstruct> </sconstruct> @@ -1020,8 +1020,8 @@ environment, of directory names, suffixes, etc. </file> </scons_example> - <scons_output example="environments_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1054,8 +1054,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1111,8 +1111,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex4"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex4" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -1172,8 +1172,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex5"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex5" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -1208,8 +1208,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_Replace1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_Replace1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1236,8 +1236,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_Replace-nonexistent"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_Replace-nonexistent" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1285,8 +1285,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_Replace2"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="environments_Replace2" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -1368,8 +1368,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex8"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex8" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1393,8 +1393,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_Append-nonexistent"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_Append-nonexistent" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1468,8 +1468,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex9"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_ex9" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1493,8 +1493,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_Prepend-nonexistent"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="environments_Prepend-nonexistent" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -1666,8 +1666,8 @@ environment, of directory names, suffixes, etc. </para> - <scons_output example="environments_ex1"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="environments_ex1" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> diff --git a/doc/user/factories.xml b/doc/user/factories.xml index 35b82d52..2e5d12ab 100644 --- a/doc/user/factories.xml +++ b/doc/user/factories.xml @@ -100,8 +100,8 @@ </para> - <scons_output example="factories_Copy1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Copy1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -124,8 +124,8 @@ </para> - <scons_output example="factories_Copy2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Copy2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -172,8 +172,8 @@ </para> - <scons_output example="factories_Copy3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Copy3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -224,8 +224,8 @@ </para> - <scons_output example="factories_Delete1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Delete1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -254,8 +254,8 @@ </para> - <scons_output example="factories_Delete2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Delete2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -318,8 +318,8 @@ </para> - <scons_output example="factories_Move"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Move" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -358,8 +358,8 @@ </para> - <scons_output example="factories_Touch"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Touch" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -409,8 +409,8 @@ </para> - <scons_output example="factories_Mkdir"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Mkdir" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -446,8 +446,8 @@ </para> - <scons_output example="factories_Chmod"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="factories_Chmod" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -482,8 +482,8 @@ </para> - <scons_output example="factories_Execute"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="factories_Execute" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> diff --git a/doc/user/file-removal.xml b/doc/user/file-removal.xml index 654b93fe..d1db56de 100644 --- a/doc/user/file-removal.xml +++ b/doc/user/file-removal.xml @@ -103,8 +103,8 @@ </para> - <scons_output example="fileremoval_precious-ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="fileremoval_precious-ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -160,9 +160,9 @@ </para> - <scons_output example="fileremoval_noclean-ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -c</scons_output_command> + <scons_output example="fileremoval_noclean-ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -c</scons_output_command> </scons_output> </section> @@ -237,9 +237,9 @@ </para> - <scons_output example="fileremoval_clean-ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q -c</scons_output_command> + <scons_output example="fileremoval_clean-ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> </scons_output> </section> diff --git a/doc/user/hierarchy.xml b/doc/user/hierarchy.xml index ff7dd1b7..8ded3661 100644 --- a/doc/user/hierarchy.xml +++ b/doc/user/hierarchy.xml @@ -361,8 +361,8 @@ make no difference to the build. </para> - <scons_output example="hierarchy_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="hierarchy_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -432,8 +432,8 @@ make no difference to the build. </para> - <scons_output example="hierarchy_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="hierarchy_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -483,8 +483,8 @@ make no difference to the build. </para> - <scons_output example="hierarchy_ex3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="hierarchy_ex3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -788,8 +788,8 @@ make no difference to the build. </para> - <scons_output example="hierarchy_Return"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="hierarchy_Return" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <!-- diff --git a/doc/user/install.xml b/doc/user/install.xml index 98c0e6d4..4921bb22 100644 --- a/doc/user/install.xml +++ b/doc/user/install.xml @@ -83,9 +83,9 @@ </para> - <scons_output example="install_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q __ROOT__/usr/bin</scons_output_command> + <scons_output example="install_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q __ROOT__/usr/bin</scons_output_command> </scons_output> <para> @@ -122,9 +122,9 @@ </para> - <scons_output example="install_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q install</scons_output_command> + <scons_output example="install_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q install</scons_output_command> </scons_output> <section> @@ -176,8 +176,8 @@ </para> - <scons_output example="install_ex3"> - <scons_output_command suffix="1">scons -Q install</scons_output_command> + <scons_output example="install_ex3" suffix="1"> + <scons_output_command>scons -Q install</scons_output_command> </scons_output> </section> @@ -215,8 +215,8 @@ </para> - <scons_output example="install_ex4"> - <scons_output_command suffix="1">scons -Q install</scons_output_command> + <scons_output example="install_ex4" suffix="1"> + <scons_output_command>scons -Q install</scons_output_command> </scons_output> </section> @@ -262,8 +262,8 @@ </para> - <scons_output example="install_ex5"> - <scons_output_command suffix="1">scons -Q install</scons_output_command> + <scons_output example="install_ex5" suffix="1"> + <scons_output_command>scons -Q install</scons_output_command> </scons_output> </section> diff --git a/doc/user/java.xml b/doc/user/java.xml index 4ddc3708..c8f559a8 100644 --- a/doc/user/java.xml +++ b/doc/user/java.xml @@ -119,8 +119,8 @@ </para> - <scons_output example="java_java"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_java" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -211,9 +211,9 @@ </para> - <scons_output example="java_java-classes"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q classes</scons_output_command> + <scons_output example="java_java-classes" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q classes</scons_output_command> </scons_output> <para> @@ -235,9 +235,9 @@ </para> - <scons_output example="java_java-classes"> - <scons_output_command suffix="3">scons -Q</scons_output_command> - <scons_output_command suffix="4">scons -Q -c classes</scons_output_command> + <scons_output example="java_java-classes" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c classes</scons_output_command> </scons_output> <para> @@ -321,8 +321,8 @@ </para> - <scons_output example="java_jar1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_jar1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -397,8 +397,8 @@ </para> - <scons_output example="java_jar2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_jar2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -462,8 +462,8 @@ </para> - <scons_output example="java_javah"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_javah" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -545,8 +545,8 @@ </para> - <scons_output example="java_JAVACLASSDIR"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_JAVACLASSDIR" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -605,8 +605,8 @@ </para> - <scons_output example="java_javah_file"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_javah_file" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -661,8 +661,8 @@ </para> - <scons_output example="java_RMIC"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="java_RMIC" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/less-simple.xml b/doc/user/less-simple.xml index 81f4c203..eb0f8216 100644 --- a/doc/user/less-simple.xml +++ b/doc/user/less-simple.xml @@ -111,8 +111,8 @@ </para> - <scons_output example="lesssimple_target" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="lesssimple_target" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -122,8 +122,8 @@ </para> - <scons_output example="lesssimple_target" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="lesssimple_target" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -166,8 +166,8 @@ </para> - <scons_output example="lesssimple_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="lesssimple_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -213,8 +213,8 @@ </para> - <scons_output example="lesssimple_ex3" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="lesssimple_ex3" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -223,8 +223,8 @@ </para> - <scons_output example="lesssimple_ex3" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="lesssimple_ex3" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -534,8 +534,8 @@ </para> - <scons_output example="lesssimple_ex4"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="lesssimple_ex4" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -609,8 +609,8 @@ </para> - <scons_output example="lesssimple_ex5"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="lesssimple_ex5" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/libraries.xml b/doc/user/libraries.xml index be097527..ad2572a6 100644 --- a/doc/user/libraries.xml +++ b/doc/user/libraries.xml @@ -87,8 +87,8 @@ </para> - <scons_output example="libraries_ex1" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="libraries_ex1" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -98,8 +98,8 @@ </para> - <scons_output example="libraries_ex1" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="libraries_ex1" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -155,8 +155,8 @@ </para> - <scons_output example="libraries_objects" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="libraries_objects" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -231,8 +231,8 @@ </para> - <scons_output example="libraries_SharedLibrary" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="libraries_SharedLibrary" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -241,8 +241,8 @@ </para> - <scons_output example="libraries_SharedLibrary" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="libraries_SharedLibrary" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -313,8 +313,8 @@ </para> - <scons_output example="libraries_ex2" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="libraries_ex2" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -324,8 +324,8 @@ </para> - <scons_output example="libraries_ex2" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="libraries_ex2" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -438,8 +438,8 @@ </para> - <scons_output example="libraries_ex3" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="libraries_ex3" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -449,8 +449,8 @@ </para> - <scons_output example="libraries_ex3" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="libraries_ex3" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <!-- The link command is too wide in the PDF version. There are some other examples of this throughout the document. --> diff --git a/doc/user/main.xml b/doc/user/main.xml index b2dbcb01..47640ec1 100644 --- a/doc/user/main.xml +++ b/doc/user/main.xml @@ -64,15 +64,19 @@ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> <bookinfo> - <title>SCons User Guide &buildversion;</title> + <title>SCons &buildversion;</title> + <subtitle>User Guide</subtitle> <author> <firstname>Steven</firstname> <surname>Knight</surname> </author> - <edition>Revision &buildrevision; (&builddate;)</edition> + <corpauthor>Stephen Knight</corpauthor> +<!-- +Revision &buildrevision; (&builddate;)</edition> +--> <pubdate>2004, 2005, 2006, 2007, 2008, 2009, 2010</pubdate> <copyright> diff --git a/doc/user/mergeflags.xml b/doc/user/mergeflags.xml index 1c73f8a3..9e0dcc6e 100644 --- a/doc/user/mergeflags.xml +++ b/doc/user/mergeflags.xml @@ -81,8 +81,8 @@ </file> </scons_example> - <scons_output example="mergeflags_MergeFlags1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="mergeflags_MergeFlags1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -108,8 +108,8 @@ </file> </scons_example> - <scons_output example="mergeflags_MergeFlags2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="mergeflags_MergeFlags2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -143,8 +143,8 @@ </file> </scons_example> - <scons_output example="mergeflags_MergeFlags3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="mergeflags_MergeFlags3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/misc.xml b/doc/user/misc.xml index 5264c78d..42f6a2da 100644 --- a/doc/user/misc.xml +++ b/doc/user/misc.xml @@ -115,8 +115,8 @@ regardless of executing Python version by faking out the infrastructure in some way. - <scons_output example="misc_EnsurePythonVersion"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_EnsurePythonVersion" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -184,8 +184,8 @@ regardless of executing SCons version by faking out the infrastructure in some way. - <scons_output example="misc_EnsureSConsVersion"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_EnsureSConsVersion" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -223,9 +223,9 @@ </file> </scons_example> - <scons_output example="misc_Exit"> - <scons_output_command suffix="1">scons -Q FUTURE=1</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="misc_Exit" suffix="1"> + <scons_output_command>scons -Q FUTURE=1</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -278,8 +278,8 @@ </file> </scons_example> - <scons_output example="misc_FindFile1a" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_FindFile1a" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <scons_example name="misc_FindFile1b"> @@ -304,8 +304,8 @@ </file> </scons_example> - <scons_output example="misc_FindFile1b" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_FindFile1b" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <!-- The man page says this should work, but it fails. @@ -337,8 +337,8 @@ exists </scons_example> - <scons_output example="misc_FindFile1c" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_FindFile1c" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -369,8 +369,8 @@ </file> </scons_example> - <scons_output example="misc_FindFile1d" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_FindFile1d" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <!-- file may be a list of file names or a single file name. --> @@ -392,8 +392,8 @@ </file> </scons_example> - <scons_output example="misc_FindFile2" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_FindFile2" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <scons_example name="misc_FindFile2"> @@ -408,8 +408,8 @@ </file> </scons_example> - <scons_output example="misc_FindFile2" os="posix"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="misc_FindFile2" os="posix" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -431,8 +431,8 @@ </file> </scons_example> - <scons_output example="misc_FindFile3" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_FindFile3" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -482,8 +482,8 @@ </para> - <scons_output example="misc_Flatten1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_Flatten1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -528,8 +528,8 @@ </para> - <scons_output example="misc_Flatten2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_Flatten2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -563,8 +563,8 @@ TODO: can't use this now because it displays the temporary path name - <scons_output example="misc_Flatten3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="misc_Flatten3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> diff --git a/doc/user/nodes.xml b/doc/user/nodes.xml index cc17e35c..8c571691 100644 --- a/doc/user/nodes.xml +++ b/doc/user/nodes.xml @@ -142,8 +142,8 @@ </para> - <scons_output example="nodes_ex1" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="nodes_ex1" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -152,8 +152,8 @@ </para> - <scons_output example="nodes_ex1" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="nodes_ex1" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -279,8 +279,8 @@ </para> - <scons_output example="nodes_print" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="nodes_print" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -289,8 +289,8 @@ </para> - <scons_output example="nodes_print" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="nodes_print" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -347,8 +347,8 @@ </para> - <scons_output example="nodes_exists" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="nodes_exists" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -384,8 +384,8 @@ </para> - <scons_output example="nodes_GetBuildPath" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="nodes_GetBuildPath" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -428,8 +428,8 @@ </para> - <scons_output example="nodes_read" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="nodes_read" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> diff --git a/doc/user/output.xml b/doc/user/output.xml index 6dd25280..05e4fe82 100644 --- a/doc/user/output.xml +++ b/doc/user/output.xml @@ -98,8 +98,8 @@ </para> - <scons_output example="output_ex1"> - <scons_output_command suffix="1">scons -h</scons_output_command> + <scons_output example="output_ex1" suffix="1"> + <scons_output_command>scons -h</scons_output_command> </scons_output> <para> @@ -147,8 +147,8 @@ </para> - <scons_output example="output_ex2" os="win32"> - <scons_output_command suffix="1">scons -h</scons_output_command> + <scons_output example="output_ex2" os="win32" suffix="1"> + <scons_output_command>scons -h</scons_output_command> </scons_output> <para> @@ -157,8 +157,8 @@ </para> - <scons_output example="output_ex2" os="posix"> - <scons_output_command suffix="2">scons -h</scons_output_command> + <scons_output example="output_ex2" os="posix" suffix="2"> + <scons_output_command>scons -h</scons_output_command> </scons_output> <para> @@ -231,8 +231,8 @@ <!-- - <scons_output example="output_COMSTR" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="output_COMSTR" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -313,10 +313,10 @@ <!-- - <scons_output example="output_COMSTR-VERBOSE" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q -c</scons_output_command> - <scons_output_command suffix="3">scons -Q VERBOSE=1</scons_output_command> + <scons_output example="output_COMSTR-VERBOSE" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q -c</scons_output_command> + <scons_output_command>scons -Q VERBOSE=1</scons_output_command> </scons_output> --> @@ -401,8 +401,8 @@ </para> - <scons_output example="output_Progress-TARGET" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="output_Progress-TARGET" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -694,9 +694,9 @@ </para> - <scons_output example="output_gbf2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q fail=1</scons_output_command> + <scons_output example="output_gbf2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q fail=1</scons_output_command> </scons_output> </section> diff --git a/doc/user/parseconfig.xml b/doc/user/parseconfig.xml index 0d619b13..ab10f966 100644 --- a/doc/user/parseconfig.xml +++ b/doc/user/parseconfig.xml @@ -105,8 +105,8 @@ no longer reports back an include directory. Since this is just for example anyway, we're just hard-coding the output. - <scons_output example="parseconfig_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="parseconfig_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> @@ -149,8 +149,8 @@ no longer reports back an include directory. Since this is just for example anyway, we're just hard-coding the output. - <scons_output example="parseconfig_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="parseconfig_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> diff --git a/doc/user/parseflags.xml b/doc/user/parseflags.xml index f327f51f..80e7720a 100644 --- a/doc/user/parseflags.xml +++ b/doc/user/parseflags.xml @@ -93,8 +93,8 @@ </file> </scons_example> - <scons_output example="parseflags_ex1" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="parseflags_ex1" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -105,8 +105,8 @@ </para> - <scons_output example="parseflags_ex1" os="win32"> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="parseflags_ex1" os="win32" suffix="2"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -132,8 +132,8 @@ </file> </scons_example> - <scons_output example="parseflags_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="parseflags_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -158,8 +158,8 @@ </file> </scons_example> - <scons_output example="parseflags_ex3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="parseflags_ex3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -185,8 +185,8 @@ </file> </scons_example> - <scons_output example="parseflags_ex4"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="parseflags_ex4" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/repositories.xml b/doc/user/repositories.xml index 902ef023..3638def3 100644 --- a/doc/user/repositories.xml +++ b/doc/user/repositories.xml @@ -150,8 +150,8 @@ </para> - <scons_output example="repositories_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="repositories_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -174,8 +174,8 @@ </file> </scons_example> - <scons_output example="repositories_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="repositories_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -197,8 +197,8 @@ </file> </scons_example> - <scons_output example="repositories_ex3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="repositories_ex3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -271,8 +271,8 @@ </para> - <scons_output example="repositories_CPPPATH"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="repositories_CPPPATH" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -310,8 +310,8 @@ </para> - <scons_output example="repositories_CPPPATH3"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="repositories_CPPPATH3" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <!-- @@ -385,8 +385,8 @@ coming into existence.) </file> </scons_example> - <scons_output example="repositories_quote1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="repositories_quote1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -530,9 +530,9 @@ coming into existence.) </file> </scons_example> - <scons_output example="repositories_ex4"> - <scons_output_command suffix="1">cd /usr/repository1</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> + <scons_output example="repositories_ex4" suffix="1"> + <scons_output_command>cd /usr/repository1</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -556,10 +556,10 @@ coming into existence.) </para> <!-- - <scons_output example="repositories_ex4"> - <scons_output_command suffix="3">cd $HOME/build</scons_output_command> - <scons_output_command suffix="4">edit hello.c</scons_output_command> - <scons_output_command suffix="5">scons -Q -Y __ROOT__/usr/repository1</scons_output_command> + <scons_output example="repositories_ex4" suffix="2"> + <scons_output_command>cd $HOME/build</scons_output_command> + <scons_output_command>edit hello.c</scons_output_command> + <scons_output_command>scons -Q -Y __ROOT__/usr/repository1</scons_output_command> </scons_output> --> <screen> diff --git a/doc/user/scanners.xml b/doc/user/scanners.xml index 304937c7..36dfd18c 100644 --- a/doc/user/scanners.xml +++ b/doc/user/scanners.xml @@ -351,11 +351,11 @@ over the file scanning rather than being called for each input line: </para> - <scons_output example="scanners_scan"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF other_file]" suffix="2">edit other_file</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> - <scons_output_command suffix="4">scons -Q</scons_output_command> + <scons_output example="scanners_scan" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF other_file]">edit other_file</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> diff --git a/doc/user/separate.xml b/doc/user/separate.xml index ea8c71ff..8fbc7a17 100644 --- a/doc/user/separate.xml +++ b/doc/user/separate.xml @@ -192,10 +192,10 @@ program using the F<build/foo.c> path name. </para> - <scons_output example="separate_ex1"> - <scons_output_command suffix="1">ls src</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">ls build</scons_output_command> + <scons_output example="separate_ex1" suffix="1"> + <scons_output_command>ls src</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>ls build</scons_output_command> </scons_output> <para> @@ -389,10 +389,10 @@ program using the F<build/foo.c> path name. </para> - <scons_output example="separate_builddir"> - <scons_output_command suffix="1">ls src</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">ls build</scons_output_command> + <scons_output example="separate_builddir" suffix="1"> + <scons_output_command>ls src</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>ls build</scons_output_command> </scons_output> <para> @@ -420,10 +420,10 @@ program using the F<build/foo.c> path name. </para> - <scons_output example="separate_duplicate0"> - <scons_output_command suffix="1">ls src</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">ls build</scons_output_command> + <scons_output example="separate_duplicate0" suffix="1"> + <scons_output_command>ls src</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>ls build</scons_output_command> </scons_output> </section> @@ -471,10 +471,10 @@ program using the F<build/foo.c> path name. </para> - <scons_output example="separate_builddir_sconscript"> - <scons_output_command suffix="1">ls src</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">ls build</scons_output_command> + <scons_output example="separate_builddir_sconscript" suffix="1"> + <scons_output_command>ls src</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>ls build</scons_output_command> </scons_output> <para> @@ -530,10 +530,10 @@ program using the F<build/foo.c> path name. </para> - <scons_output example="separate_glob_builddir_sconscript"> - <scons_output_command suffix="1">ls src</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">ls build</scons_output_command> + <scons_output example="separate_glob_builddir_sconscript" suffix="1"> + <scons_output_command>ls src</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>ls build</scons_output_command> </scons_output> <para> diff --git a/doc/user/sideeffect.xml b/doc/user/sideeffect.xml index dd0203ac..f3733435 100644 --- a/doc/user/sideeffect.xml +++ b/doc/user/sideeffect.xml @@ -92,8 +92,8 @@ </para> - <scons_output example="sideeffect_simple"> - <scons_output_command suffix="1">scons -Q --jobs=2</scons_output_command> + <scons_output example="sideeffect_simple" suffix="1"> + <scons_output_command>scons -Q --jobs=2</scons_output_command> </scons_output> <para> @@ -181,8 +181,8 @@ </para> - <scons_output example="sideeffect_shared"> - <scons_output_command suffix="1">scons -Q --jobs=2</scons_output_command> + <scons_output example="sideeffect_shared" suffix="1"> + <scons_output_command>scons -Q --jobs=2</scons_output_command> </scons_output> <para> @@ -207,8 +207,8 @@ </file> </scons_example> - <scons_output example="sideeffect_parallel"> - <scons_output_command suffix="1">scons -Q --jobs=2</scons_output_command> + <scons_output example="sideeffect_parallel" suffix="1"> + <scons_output_command>scons -Q --jobs=2</scons_output_command> </scons_output> <para> diff --git a/doc/user/simple.xml b/doc/user/simple.xml index 323d83f7..34d5dc6f 100644 --- a/doc/user/simple.xml +++ b/doc/user/simple.xml @@ -112,8 +112,8 @@ </para> - <scons_output example="simple_ex1" os="posix"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="simple_ex1" os="posix" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -123,8 +123,8 @@ </para> - <scons_output example="simple_ex1" os="win32"> - <scons_output_command suffix="2">scons</scons_output_command> + <scons_output example="simple_ex1" os="win32" suffix="2"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -193,8 +193,8 @@ </para> - <scons_output example="simple_Object" os="posix"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="simple_Object" os="posix" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -204,8 +204,8 @@ </para> - <scons_output example="simple_Object" os="win32"> - <scons_output_command suffix="2">scons</scons_output_command> + <scons_output example="simple_Object" os="win32" suffix="2"> + <scons_output_command>scons</scons_output_command> </scons_output> </section> @@ -251,8 +251,8 @@ </para> - <scons_output example="simple_java" os="posix"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="simple_java" os="posix" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -292,9 +292,9 @@ </file> </scons_example> - <scons_output example="simple_clean" os="posix"> - <scons_output_command suffix="1">scons</scons_output_command> - <scons_output_command suffix="2">scons -c</scons_output_command> + <scons_output example="simple_clean" os="posix" suffix="1"> + <scons_output_command>scons</scons_output_command> + <scons_output_command>scons -c</scons_output_command> </scons_output> <para> @@ -303,9 +303,9 @@ </para> - <scons_output example="simple_clean" os="win32"> - <scons_output_command suffix="3">scons</scons_output_command> - <scons_output_command suffix="4">scons -c</scons_output_command> + <scons_output example="simple_clean" os="win32" suffix="2"> + <scons_output_command>scons</scons_output_command> + <scons_output_command>scons -c</scons_output_command> </scons_output> <para> @@ -467,8 +467,8 @@ </para> - <scons_output example="simple_declarative" os="posix"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="simple_declarative" os="posix" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -495,8 +495,8 @@ </para> - <scons_output example="simple_ex1" os="win32"> - <scons_output_command suffix="3">scons</scons_output_command> + <scons_output example="simple_ex1" os="win32" suffix="3"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -521,8 +521,8 @@ </para> - <scons_output example="simple_ex1" os="win32"> - <scons_output_command suffix="4">scons -Q</scons_output_command> + <scons_output example="simple_ex1" os="win32" suffix="4"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> diff --git a/doc/user/sourcecode.xml b/doc/user/sourcecode.xml index 7251dcee..c1a97a25 100644 --- a/doc/user/sourcecode.xml +++ b/doc/user/sourcecode.xml @@ -74,8 +74,8 @@ </file> </scons_example> - <scons_output example="sourcecode_bitkeeper"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="sourcecode_bitkeeper" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -97,8 +97,8 @@ </file> </scons_example> - <scons_output example="sourcecode_cvs"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="sourcecode_cvs" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -123,8 +123,8 @@ </file> </scons_example> - <scons_output example="sourcecode_rcs"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="sourcecode_rcs" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -149,8 +149,8 @@ </file> </scons_example> - <scons_output example="sourcecode_sccs"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="sourcecode_sccs" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> @@ -174,8 +174,8 @@ </file> </scons_example> - <scons_output example="sourcecode_subversion"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="sourcecode_subversion" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </section> diff --git a/doc/user/tasks.xml b/doc/user/tasks.xml index ea020259..a1105b19 100644 --- a/doc/user/tasks.xml +++ b/doc/user/tasks.xml @@ -160,8 +160,8 @@ Where main.cpp looks like this: produces this: </para> - <scons_output example="tasks_ex1"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="tasks_ex1" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> </example> diff --git a/doc/user/troubleshoot.xml b/doc/user/troubleshoot.xml index d8bcf6ed..55002dbc 100644 --- a/doc/user/troubleshoot.xml +++ b/doc/user/troubleshoot.xml @@ -119,10 +119,10 @@ </para> - <scons_output example="troubleshoot_explain1" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command suffix="2">scons -Q</scons_output_command> - <scons_output_command suffix="3">scons -Q</scons_output_command> + <scons_output example="troubleshoot_explain1" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -142,8 +142,8 @@ </para> - <scons_output example="troubleshoot_explain1" os="posix"> - <scons_output_command suffix="4">scons -Q --debug=explain</scons_output_command> + <scons_output example="troubleshoot_explain1" os="posix" suffix="2"> + <scons_output_command>scons -Q --debug=explain</scons_output_command> </scons_output> <para> @@ -187,10 +187,10 @@ </file> </scons_example> - <scons_output example="troubleshoot_explain2" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF file2.c]" suffix="2">edit file2.c</scons_output_command> - <scons_output_command suffix="3">scons -Q --debug=explain</scons_output_command> + <scons_output example="troubleshoot_explain2" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF file2.c]">edit file2.c</scons_output_command> + <scons_output_command>scons -Q --debug=explain</scons_output_command> </scons_output> <para> @@ -230,10 +230,10 @@ </file> </scons_example> - <scons_output example="troubleshoot_explain3" os="posix"> - <scons_output_command suffix="1">scons -Q</scons_output_command> - <scons_output_command output=" [CHANGE THE CONTENTS OF hello.h]" suffix="2">edit hello.h</scons_output_command> - <scons_output_command suffix="3">scons -Q --debug=explain</scons_output_command> + <scons_output example="troubleshoot_explain3" os="posix" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> + <scons_output_command output=" [CHANGE THE CONTENTS OF hello.h]">edit hello.h</scons_output_command> + <scons_output_command>scons -Q --debug=explain</scons_output_command> </scons_output> <para> @@ -290,8 +290,8 @@ </para> - <scons_output example="troubleshoot_Dump" os="posix" tools="gcc"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="troubleshoot_Dump" os="posix" tools="gcc" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -301,8 +301,8 @@ </para> - <scons_output example="troubleshoot_Dump" os="win32" tools="msvc"> - <scons_output_command suffix="2">scons</scons_output_command> + <scons_output example="troubleshoot_Dump" os="win32" tools="msvc" suffix="2"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -349,8 +349,8 @@ </para> - <scons_output example="troubleshoot_Dump_ENV" os="posix"> - <scons_output_command suffix="1">scons</scons_output_command> + <scons_output example="troubleshoot_Dump_ENV" os="posix" suffix="1"> + <scons_output_command>scons</scons_output_command> </scons_output> <para> @@ -359,8 +359,8 @@ </para> - <scons_output example="troubleshoot_Dump_ENV" os="win32"> - <scons_output_command suffix="2">scons</scons_output_command> + <scons_output example="troubleshoot_Dump_ENV" os="win32" suffix="2"> + <scons_output_command>scons</scons_output_command> </scons_output> </section> @@ -415,8 +415,8 @@ </para> - <scons_output example="troubleshoot_tree1"> - <scons_output_command suffix="1">scons -Q --tree=all</scons_output_command> + <scons_output example="troubleshoot_tree1" suffix="1"> + <scons_output_command>scons -Q --tree=all</scons_output_command> </scons_output> <para> @@ -441,8 +441,8 @@ </para> - <scons_output example="troubleshoot_tree1"> - <scons_output_command suffix="2">scons -Q --tree=all f2.o</scons_output_command> + <scons_output example="troubleshoot_tree1" suffix="2"> + <scons_output_command>scons -Q --tree=all f2.o</scons_output_command> </scons_output> <para> @@ -457,8 +457,8 @@ </para> - <scons_output example="troubleshoot_tree1"> - <scons_output_command suffix="3">scons -Q --tree=all f1.o f3.o</scons_output_command> + <scons_output example="troubleshoot_tree1" suffix="3"> + <scons_output_command>scons -Q --tree=all f1.o f3.o</scons_output_command> </scons_output> <para> @@ -469,8 +469,8 @@ </para> - <scons_output example="troubleshoot_tree1"> - <scons_output_command suffix="4">scons -Q --tree=status</scons_output_command> + <scons_output example="troubleshoot_tree1" suffix="4"> + <scons_output_command>scons -Q --tree=status</scons_output_command> </scons_output> <para> @@ -487,8 +487,8 @@ </para> - <scons_output example="troubleshoot_tree1"> - <scons_output_command suffix="5">scons -Q --tree=derived</scons_output_command> + <scons_output example="troubleshoot_tree1" suffix="5"> + <scons_output_command>scons -Q --tree=derived</scons_output_command> </scons_output> <para> @@ -498,8 +498,8 @@ </para> - <scons_output example="troubleshoot_tree1"> - <scons_output_command suffix="6">scons -Q --tree=derived,status</scons_output_command> + <scons_output example="troubleshoot_tree1" suffix="6"> + <scons_output_command>scons -Q --tree=derived,status</scons_output_command> </scons_output> <para> @@ -557,8 +557,8 @@ </para> - <scons_output example="troubleshoot_tree2"> - <scons_output_command suffix="1">scons -Q --tree=all</scons_output_command> + <scons_output example="troubleshoot_tree2" suffix="1"> + <scons_output_command>scons -Q --tree=all</scons_output_command> </scons_output> <para> @@ -579,8 +579,8 @@ </para> - <scons_output example="troubleshoot_tree2"> - <scons_output_command suffix="2">scons -Q --tree=prune</scons_output_command> + <scons_output example="troubleshoot_tree2" suffix="2"> + <scons_output_command>scons -Q --tree=prune</scons_output_command> </scons_output> <para> @@ -623,8 +623,8 @@ shows the Python functions from the sconsdoc.py execution wrapper used to generate this manual, not the underlying command-line strings. - <scons_output example="troubleshoot_presub"> - <scons_output_command suffix="1">scons -Q - -debug=presub</scons_output_command> + <scons_output example="troubleshoot_presub" suffix="1"> + <scons_output_command>scons -Q - -debug=presub</scons_output_command> </scons_output> --> @@ -681,8 +681,8 @@ </para> - <scons_output example="troubleshoot_findlibs"> - <scons_output_command suffix="1">scons -Q --debug=findlibs</scons_output_command> + <scons_output example="troubleshoot_findlibs" suffix="1"> + <scons_output_command>scons -Q --debug=findlibs</scons_output_command> </scons_output> </section> @@ -717,8 +717,8 @@ </file> </scons_example> - <scons_output example="troubleshoot_includes"> - <scons_output_command suffix="1">scons -Q - - debug=includes prog</scons_output_command> + <scons_output example="troubleshoot_includes" suffix="1"> + <scons_output_command>scons -Q - - debug=includes prog</scons_output_command> </scons_output> </section> @@ -761,8 +761,8 @@ </para> - <scons_output example="troubleshoot_stacktrace"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="troubleshoot_stacktrace" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> <para> @@ -778,8 +778,8 @@ </para> - <scons_output example="troubleshoot_stacktrace"> - <scons_output_command suffix="2">scons -Q --debug=stacktrace</scons_output_command> + <scons_output example="troubleshoot_stacktrace" suffix="2"> + <scons_output_command>scons -Q --debug=stacktrace</scons_output_command> </scons_output> <para> @@ -841,8 +841,8 @@ </file> </scons_example> - <scons_output example="troubleshoot_taskmastertrace" os="posix"> - <scons_output_command suffix="1">scons -Q --taskmastertrace=- prog</scons_output_command> + <scons_output example="troubleshoot_taskmastertrace" os="posix" suffix="1"> + <scons_output_command>scons -Q --taskmastertrace=- prog</scons_output_command> </scons_output> <para> diff --git a/doc/user/variants.xml b/doc/user/variants.xml index 8daff22c..1a937e5a 100644 --- a/doc/user/variants.xml +++ b/doc/user/variants.xml @@ -141,8 +141,8 @@ is pretty smart about rebuilding things when you change options. </para> - <scons_output example="variants_ex" os="posix"> - <scons_output_command suffix="1">scons -Q OS=linux</scons_output_command> + <scons_output example="variants_ex" os="posix" suffix="1"> + <scons_output_command>scons -Q OS=linux</scons_output_command> </scons_output> <para> @@ -151,8 +151,8 @@ is pretty smart about rebuilding things when you change options. </para> - <scons_output example="variants_ex" os="win32"> - <scons_output_command suffix="2">scons -Q OS=windows</scons_output_command> + <scons_output example="variants_ex" os="win32" suffix="2"> + <scons_output_command>scons -Q OS=windows</scons_output_command> </scons_output> <!-- @@ -165,8 +165,8 @@ is pretty smart about rebuilding things when you change options. </file> </scons_example> - <scons_output example="variants_ex2"> - <scons_output_command suffix="1">scons -Q</scons_output_command> + <scons_output example="variants_ex2" suffix="1"> + <scons_output_command>scons -Q</scons_output_command> </scons_output> --> diff --git a/doc/version.xml b/doc/version.xml index a52506bd..f6eba1f3 100644 --- a/doc/version.xml +++ b/doc/version.xml @@ -2,6 +2,6 @@ <!-- THIS IS AN AUTOMATICALLY-GENERATED FILE. DO NOT EDIT. --> -<!ENTITY builddate "today"> -<!ENTITY buildversion "1.0.0"> -<!ENTITY buildrevision "docdev"> +<!ENTITY builddate "2013-03-23"> +<!ENTITY buildversion "2.3.0"> +<!ENTITY buildrevision "1"> diff --git a/doc/xsd/dbpoolx.xsd b/doc/xsd/dbpoolx.xsd index b5e856fe..f0a3f1ca 100644 --- a/doc/xsd/dbpoolx.xsd +++ b/doc/xsd/dbpoolx.xsd @@ -2349,6 +2349,7 @@ <xs:attribute name="name" type="xs:string" /> <xs:attribute name="tools" type="xs:string" /> <xs:attribute name="example" type="xs:string" use="required" /> + <xs:attribute name="suffix" type="xs:string" use="required" /> </xs:attributeGroup> <!-- end of scons_output.attlist --> <!-- end of scons_output.module --> @@ -2380,7 +2381,6 @@ <xs:attribute name="edit" type="xs:string" use="optional" /> <xs:attribute name="environment" type="xs:string" use="optional" /> <xs:attribute name="output" type="xs:string" use="optional" /> - <xs:attribute name="suffix" type="xs:string" use="required" /> </xs:attributeGroup> <!-- end of scons_output_command.attlist --> <!-- end of scons_output_command.module --> diff --git a/doc/xslt/to_docbook.xslt b/doc/xslt/to_docbook.xslt index 25da999e..0b39c28f 100644 --- a/doc/xslt/to_docbook.xslt +++ b/doc/xslt/to_docbook.xslt @@ -19,6 +19,28 @@ <xsl:copy/> </xsl:template> + <!-- Helper function for replacing strings in strings --> + <xsl:template name="string-replace-all"> + <xsl:param name="text" /> + <xsl:param name="replace" /> + <xsl:param name="by" /> + <xsl:choose> + <xsl:when test="contains($text, $replace)"> + <xsl:value-of select="substring-before($text,$replace)" /> + <xsl:value-of select="$by" /> + <xsl:call-template name="string-replace-all"> + <xsl:with-param name="text" + select="substring-after($text,$replace)" /> + <xsl:with-param name="replace" select="$replace" /> + <xsl:with-param name="by" select="$by" /> + </xsl:call-template> + </xsl:when> + <xsl:otherwise> + <xsl:value-of select="$text" /> + </xsl:otherwise> + </xsl:choose> + </xsl:template> + <!-- Leaving scons_example empty --> <xsl:template match="scons:scons_example"> <xsl:apply-templates select="node()"/> @@ -31,11 +53,10 @@ </xsl:element> </xsl:template> - <!-- Changing scons_output to screen --> + <!-- Leaving scons_output empty, should already + have been handled by xinclude_examples.xslt --> <xsl:template match="scons:scons_output"> - <xsl:element name="screen"> - <xsl:apply-templates select="node()"/> - </xsl:element> + <xsl:apply-templates select="node()"/> </xsl:template> <!-- Leaving scons_output_command empty, should already @@ -54,7 +75,11 @@ <xsl:template match="scons:file"> <xsl:if test="@printme='1'"> <xsl:element name="programlisting"> - <xsl:apply-templates select="node()"/> + <xsl:call-template name="string-replace-all"> + <xsl:with-param name="text" select="node()" /> + <xsl:with-param name="replace" select="'__ROOT__'" /> + <xsl:with-param name="by" select="''" /> + </xsl:call-template> </xsl:element> </xsl:if> </xsl:template> @@ -62,7 +87,11 @@ <!-- Changing sconstruct to programlisting --> <xsl:template match="scons:sconstruct"> <xsl:element name="programlisting"> - <xsl:apply-templates select="node()"/> + <xsl:call-template name="string-replace-all"> + <xsl:with-param name="text" select="node()" /> + <xsl:with-param name="replace" select="'__ROOT__'" /> + <xsl:with-param name="by" select="''" /> + </xsl:call-template> </xsl:element> </xsl:template> diff --git a/doc/xslt/xinclude_examples.xslt b/doc/xslt/xinclude_examples.xslt index 982391f7..50696ac9 100644 --- a/doc/xslt/xinclude_examples.xslt +++ b/doc/xslt/xinclude_examples.xslt @@ -19,11 +19,10 @@ <xsl:copy/> </xsl:template> - <!-- Changing scons_output_command to xinclude --> - <xsl:template match="scons:scons_output_command"> + <!-- Changing scons_output to xinclude --> + <xsl:template match="scons:scons_output"> <xsl:element name="xsi:include"> - <xsl:attribute name="href"><xsl:value-of select="concat('../generated/examples/',../@example,'_',@suffix,'.out')"></xsl:value-of></xsl:attribute> - <xsl:attribute name="parse">text</xsl:attribute> + <xsl:attribute name="href"><xsl:value-of select="concat('../generated/examples/',@example,'_',@suffix,'.xml')"></xsl:value-of></xsl:attribute> </xsl:element> </xsl:template> |