From 16b9af694bf59ce40234450db01017be85d396b3 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Mon, 20 Nov 2023 13:41:18 -0700 Subject: Housekeeping: normalize license info in User Guide All the files have a consistent copyright/license header now. There are no content changes (well, a couple of line joins and line endings, but that does not affect output) Signed-off-by: Mats Wichmann --- doc/user/README | 5 +-- doc/user/SConstruct | 60 ++++++++++++----------------------- doc/user/actions.xml | 35 +++++--------------- doc/user/add-method.xml | 8 ++--- doc/user/alias.xml | 35 +++++--------------- doc/user/ant.xml | 35 +++++--------------- doc/user/build-install.xml | 4 +-- doc/user/builders-built-in.xml | 35 +++++--------------- doc/user/builders-commands.xml | 35 +++++--------------- doc/user/builders-writing.xml | 35 ++++---------------- doc/user/builders.xml | 33 ++++--------------- doc/user/caching.xml | 4 +-- doc/user/chtml.xsl | 26 +++------------ doc/user/command-line.xml | 35 ++++---------------- doc/user/depends.xml | 37 +++++----------------- doc/user/environments.xml | 31 ++++-------------- doc/user/epub.xsl | 26 +++------------ doc/user/errors.xml | 33 ++++--------------- doc/user/example.xml | 35 +++++--------------- doc/user/external.xml | 33 ++++--------------- doc/user/factories.xml | 37 ++++++---------------- doc/user/file-removal.xml | 35 +++++--------------- doc/user/functions.xml | 33 ++++--------------- doc/user/gettext.xml | 41 +++++++----------------- doc/user/hierarchy.xml | 6 ++-- doc/user/html.xsl | 26 +++------------ doc/user/install.xml | 31 ++++-------------- doc/user/java.xml | 14 ++++---- doc/user/less-simple.xml | 5 +-- doc/user/libraries.xml | 37 ++++++---------------- doc/user/main.xml | 27 ++-------------- doc/user/make.xml | 35 +++++--------------- doc/user/mergeflags.xml | 35 ++++---------------- doc/user/misc.xml | 31 ++++-------------- doc/user/nodes.xml | 35 ++++---------------- doc/user/output.xml | 4 +-- doc/user/parse_flags_arg.xml | 31 ++++-------------- doc/user/parseconfig.xml | 35 ++++---------------- doc/user/parseflags.xml | 35 ++++---------------- doc/user/pdf.xsl | 25 ++------------- doc/user/preface.xml | 35 ++++---------------- doc/user/python.xml | 35 +++++--------------- doc/user/repositories.xml | 35 +++++--------------- doc/user/run.xml | 33 ++++--------------- doc/user/scanners.xml | 51 +++++++++--------------------- doc/user/sconf.xml | 35 ++++---------------- doc/user/scons_title.xsl | 72 ++++++++++++++++-------------------------- doc/user/separate.xml | 4 +-- doc/user/sideeffect.xml | 33 ++++--------------- doc/user/simple.xml | 4 +-- doc/user/tasks.xml | 39 ++++++----------------- doc/user/tools.xml | 33 ++++--------------- doc/user/troubleshoot.xml | 31 ++++-------------- doc/user/variables.xml | 33 ++++--------------- doc/user/variants.xml | 7 ++-- 55 files changed, 383 insertions(+), 1235 deletions(-) diff --git a/doc/user/README b/doc/user/README index f94632d..1e0bd13 100644 --- a/doc/user/README +++ b/doc/user/README @@ -1,11 +1,12 @@ -# __COPYRIGHT__ +# SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org) +# SPDX-License-Identifier: MIT When adding a new file, add it to main.xml and MANIFEST. To build the .xml files from the .in files: scons -D BUILDDOC=1 foo.xml To build the whole PDF doc from this dir, for testing: - scons -D ../../build/doc/PDF/scons-user.pdf + scons -D ../../build/doc/PDF/scons-user.pdf Writing examples: here's a simple template. diff --git a/doc/user/SConstruct b/doc/user/SConstruct index cfd85cf..b64482b 100644 --- a/doc/user/SConstruct +++ b/doc/user/SConstruct @@ -1,57 +1,36 @@ +# SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org) +# SPDX-License-Identifier: MIT # # SConstruct file for building SCons documentation. # -# -# __COPYRIGHT__ -# -# 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. - import os -env = Environment(ENV={'PATH' : os.environ['PATH']}, - tools=['docbook','gs','zip'], - toolpath=['../../SCons/Tool'], - # DOCBOOK_XSLTPROCFLAGS="--stringparam fop.extensions 1", - DOCBOOK_DEFAULT_XSL_HTML='html.xsl', - DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl', - DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl') +env = Environment( + ENV={'PATH': os.environ['PATH']}, + tools=['docbook', 'gs', 'zip'], + toolpath=['../../SCons/Tool'], + # DOCBOOK_XSLTPROCFLAGS="--stringparam fop.extensions 1", + DOCBOOK_DEFAULT_XSL_HTML='html.xsl', + DOCBOOK_DEFAULT_XSL_HTMLCHUNKED='chtml.xsl', + DOCBOOK_DEFAULT_XSL_PDF='pdf.xsl', +) has_pdf = False -if (env.WhereIs('fop') or - env.WhereIs('xep')): +if env.WhereIs('fop') or env.WhereIs('xep'): has_pdf = True # # UserGuide for SCons # env.DocbookXInclude('scons_xi.xml', 'main.xml') -env.DocbookXslt('scons_ex.xml', 'scons_xi.xml', - xsl='../xslt/xinclude_examples.xslt') +env.DocbookXslt('scons_ex.xml', 'scons_xi.xml', xsl='../xslt/xinclude_examples.xslt') env.DocbookXInclude('scons_exi.xml', 'scons_ex.xml') -env.DocbookXslt('scons_db.xml', 'scons_exi.xml', - xsl='../xslt/to_docbook.xslt') -env.DocbookHtml('index.html','scons_db.xml') +env.DocbookXslt('scons_db.xml', 'scons_exi.xml', xsl='../xslt/to_docbook.xslt') +env.DocbookHtml('index.html', 'scons_db.xml') env.DocbookHtmlChunked('index.html', 'scons_db.xml', base_dir='scons-user/') if has_pdf: - env.DocbookPdf('scons-user.pdf','scons_db.xml') + env.DocbookPdf('scons-user.pdf', 'scons_db.xml') has_gs = False if env.WhereIs('gs'): @@ -61,7 +40,10 @@ if env.WhereIs('gs'): # Create the EPUB format # if has_gs and has_pdf: - jpg = env.Gs('OEBPS/cover.jpg','scons-user.pdf', - GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -dJPEGQ=100 -r72x72 -q') + jpg = env.Gs( + 'OEBPS/cover.jpg', + 'scons-user.pdf', + GSFLAGS='-dNOPAUSE -dBATCH -sDEVICE=jpeg -dFirstPage=1 -dLastPage=1 -dJPEGQ=100 -r72x72 -q', + ) epub = env.DocbookEpub('scons-user.epub', 'scons_db.xml', xsl='epub.xsl') env.Depends(epub, jpg) diff --git a/doc/user/actions.xml b/doc/user/actions.xml index c980f9c..d357eb6 100644 --- a/doc/user/actions.xml +++ b/doc/user/actions.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> - - %scons; - + %builders-mod; @@ -17,7 +17,7 @@ Copyright The SCons Foundation %tools-mod; %variables-mod; - + ]> + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> Alias Targets - - We've already seen how you can use the &Alias; diff --git a/doc/user/ant.xml b/doc/user/ant.xml index e829d0e..17f44fc 100644 --- a/doc/user/ant.xml +++ b/doc/user/ant.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> Converting From Ant - - XXX diff --git a/doc/user/build-install.xml b/doc/user/build-install.xml index 3f6982c..f2b7241 100644 --- a/doc/user/build-install.xml +++ b/doc/user/build-install.xml @@ -1,8 +1,8 @@ + + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> Built-In Builders - - &SCons; provides the ability to build a lot of different diff --git a/doc/user/builders-commands.xml b/doc/user/builders-commands.xml index 7d47dae..ba01e0c 100644 --- a/doc/user/builders-commands.xml +++ b/doc/user/builders-commands.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -20,31 +26,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Not Writing a Builder: the &Command; Builder - - + %scons; @@ -20,34 +26,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Extending &SCons;: Writing Your Own Builders - - - + Although &SCons; provides many useful methods for building common software products diff --git a/doc/user/builders.xml b/doc/user/builders.xml index 9fd83d7..9383424 100644 --- a/doc/user/builders.xml +++ b/doc/user/builders.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Builders - - This appendix contains descriptions of all of the diff --git a/doc/user/caching.xml b/doc/user/caching.xml index 8cca510..b79cd62 100644 --- a/doc/user/caching.xml +++ b/doc/user/caching.xml @@ -1,8 +1,8 @@ + - + + + + %scons; @@ -20,34 +26,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Controlling a Build From the Command Line - - - + &SCons; provides a number of ways for you as the writer of the &SConscript; files diff --git a/doc/user/depends.xml b/doc/user/depends.xml index 62b6d91..961edb2 100644 --- a/doc/user/depends.xml +++ b/doc/user/depends.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -20,34 +26,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Dependencies - - - + So far we've seen how &SCons; handles one-time builds. But one of the main functions of a build tool like &SCons; @@ -125,7 +104,7 @@ int main() { printf("Hello, world!\n"); } - By default, &SCons; + By default, &SCons; uses a cryptographic hash of the file's contents, not the file's modification time, to decide whether a file has changed. diff --git a/doc/user/environments.xml b/doc/user/environments.xml index 7118f21..b4f8689 100644 --- a/doc/user/environments.xml +++ b/doc/user/environments.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -22,31 +28,6 @@ - - + + + + %scons; - + %builders-mod; @@ -20,31 +26,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Errors - - XXX diff --git a/doc/user/example.xml b/doc/user/example.xml index a4e3b99..18783de 100644 --- a/doc/user/example.xml +++ b/doc/user/example.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> Complex &SCons; Example - - XXX diff --git a/doc/user/external.xml b/doc/user/external.xml index ceeece0..46314c4 100644 --- a/doc/user/external.xml +++ b/doc/user/external.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -20,33 +26,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Using SCons with other build tools - - Sometimes a project needs to interact with other projects diff --git a/doc/user/factories.xml b/doc/user/factories.xml index 362b6f0..905b959 100644 --- a/doc/user/factories.xml +++ b/doc/user/factories.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -20,31 +26,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Platform-Independent File System Manipulation - - &SCons; provides a number of platform-independent functions, @@ -183,7 +164,7 @@ touch $* The &Copy; factory has a third optional argument which controls how symlinks are copied. - + @@ -404,7 +385,7 @@ SConscript('S') For example, if we need to process a file in a temporary directory in which the processing tool - will create other files that we don't care about, + will create other files that we don't care about, you could use: diff --git a/doc/user/file-removal.xml b/doc/user/file-removal.xml index 6eb688d..4f93b20 100644 --- a/doc/user/file-removal.xml +++ b/doc/user/file-removal.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> Controlling Removal of Targets - - There are two occasions when &SCons; will, diff --git a/doc/user/functions.xml b/doc/user/functions.xml index 8044310..9185f4a 100644 --- a/doc/user/functions.xml +++ b/doc/user/functions.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Functions and Environment Methods - - This appendix contains descriptions of all of the diff --git a/doc/user/gettext.xml b/doc/user/gettext.xml index 331ec33..b9ebbbd 100644 --- a/doc/user/gettext.xml +++ b/doc/user/gettext.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -11,7 +17,7 @@ %tools-mod; %variables-mod; - + ]> Internationalization and localization with gettext - - The &t-link-gettext; toolset supports internationalization and localization of SCons-based projects. Builders provided by &t-link-gettext; automatize @@ -76,7 +57,7 @@
Simple project - Let's start with a very simple project, the "Hello world" program + Let's start with a very simple project, the "Hello world" program for example @@ -145,7 +126,7 @@ int main(int argc, char* argv[]) translate the message at runtime. - + Now we shall instruct SCons how to generate and maintain translation files. For that, use the &b-link-Translate; builder and &b-link-MOFiles; builder. The first one takes source files, extracts internationalized @@ -158,7 +139,7 @@ int main(int argc, char* argv[]) called locale. - The completed + The completed SConstruct is as follows: diff --git a/doc/user/hierarchy.xml b/doc/user/hierarchy.xml index 17874d0..c501e53 100644 --- a/doc/user/hierarchy.xml +++ b/doc/user/hierarchy.xml @@ -1,8 +1,8 @@ + print for debugging, or write a Python function that wants to evaluate a path. - You can force &SCons; to evaluate a top-relative path + You can force &SCons; to evaluate a top-relative path and produce a string that can be used by &Python; code by creating a Node object from it: diff --git a/doc/user/html.xsl b/doc/user/html.xsl index fa3d915..6def44b 100644 --- a/doc/user/html.xsl +++ b/doc/user/html.xsl @@ -1,28 +1,10 @@ - + diff --git a/doc/user/install.xml b/doc/user/install.xml index d5ea4d8..b1ae1f6 100644 --- a/doc/user/install.xml +++ b/doc/user/install.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -20,31 +26,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Installing Files in Other Directories: the &Install; Builder - - Once a program is built, diff --git a/doc/user/java.xml b/doc/user/java.xml index 4f1beef..1a51621 100644 --- a/doc/user/java.xml +++ b/doc/user/java.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -19,13 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Java Builds - - - + So far, we've been using examples of building C and C++ programs diff --git a/doc/user/less-simple.xml b/doc/user/less-simple.xml index 8a30cdf..56d4f49 100644 --- a/doc/user/less-simple.xml +++ b/doc/user/less-simple.xml @@ -1,9 +1,10 @@ + + %scons; diff --git a/doc/user/libraries.xml b/doc/user/libraries.xml index d7983c9..67e8a52 100644 --- a/doc/user/libraries.xml +++ b/doc/user/libraries.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Building and Linking with Libraries - - It's often useful to organize large software projects @@ -269,7 +250,7 @@ void f3() { printf("f3.c\n"); } You link libraries with a program by specifying the libraries in the &cv-link-LIBS; construction variable, and by specifying the directory in which - the library will be found in the + the library will be found in the &cv-link-LIBPATH; construction variable: diff --git a/doc/user/main.xml b/doc/user/main.xml index 2825dba..ba18279 100644 --- a/doc/user/main.xml +++ b/doc/user/main.xml @@ -1,29 +1,8 @@ - + + + %scons; - + %builders-mod; @@ -10,7 +16,7 @@ %tools-mod; - %variables-mod; + %variables-mod; ]> - - + %scons; @@ -19,34 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Merging Options into the Environment: the &MergeFlags; Function - - - + &SCons; &consenvs; have a &f-link-MergeFlags; method that merges values from a passed-in argument into the &consenv;. diff --git a/doc/user/misc.xml b/doc/user/misc.xml index b1e1507..ef2e4ca 100644 --- a/doc/user/misc.xml +++ b/doc/user/misc.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Miscellaneous Functionality - - &SCons; supports a lot of additional functionality diff --git a/doc/user/nodes.xml b/doc/user/nodes.xml index 66b37cf..83514ec 100644 --- a/doc/user/nodes.xml +++ b/doc/user/nodes.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -19,34 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Node Objects - - - + Internally, &SCons; represents all of the files and directories it knows about as &Nodes;. diff --git a/doc/user/output.xml b/doc/user/output.xml index 7a63540..ebcf06e 100644 --- a/doc/user/output.xml +++ b/doc/user/output.xml @@ -1,8 +1,8 @@ + + + + %scons; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Merging Options While Creating Environment: the <parameter>parse_flags</parameter> Parameter - - It is also possible to merge &consvar; values from arguments diff --git a/doc/user/parseconfig.xml b/doc/user/parseconfig.xml index fc9a889..c7fcdd6 100644 --- a/doc/user/parseconfig.xml +++ b/doc/user/parseconfig.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -19,34 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Finding Installed Library Information: the &ParseConfig; Function - - - + Configuring the right options to build programs to work with libraries--especially shared libraries--that are available diff --git a/doc/user/parseflags.xml b/doc/user/parseflags.xml index a1ab7af..a007f9b 100644 --- a/doc/user/parseflags.xml +++ b/doc/user/parseflags.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -19,34 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Separating Compile Arguments into their Variables: the &ParseFlags; Function - - - + &SCons; has a bewildering array of &consvars; for different types of options when building programs. diff --git a/doc/user/pdf.xsl b/doc/user/pdf.xsl index c975f0e..a628188 100644 --- a/doc/user/pdf.xsl +++ b/doc/user/pdf.xsl @@ -1,27 +1,8 @@ - + + + %scons; @@ -19,34 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Preface - - - + Thank you for taking the time to read about &SCons;. &SCons; is a modern diff --git a/doc/user/python.xml b/doc/user/python.xml index cac61a1..dc10a7b 100644 --- a/doc/user/python.xml +++ b/doc/user/python.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -20,31 +26,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Python overview - - This section will provide a brief overview of @@ -155,7 +136,7 @@ while: statements look like break statements look like - + continue statements look like diff --git a/doc/user/repositories.xml b/doc/user/repositories.xml index 77d75d3..261ec0a 100644 --- a/doc/user/repositories.xml +++ b/doc/user/repositories.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Building From Code Repositories - - Often, a software project will have @@ -540,7 +521,7 @@ int f2() { printf("file2.c\n"); } - + (Note that this is safe even if the &SConstruct; file lists /usr/repository1 as a repository, because &SCons; will remove the current build directory diff --git a/doc/user/run.xml b/doc/user/run.xml index 3025afb..acedd4b 100644 --- a/doc/user/run.xml +++ b/doc/user/run.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -21,31 +27,6 @@ - - + %scons; - + %builders-mod; @@ -21,33 +27,6 @@ - - + %scons; @@ -19,34 +25,7 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Multi-Platform Configuration (&Autoconf; Functionality) - - - + &SCons; has integrated support for build configuration similar in style to GNU &Autoconf;, but designed to be diff --git a/doc/user/scons_title.xsl b/doc/user/scons_title.xsl index 2eb1293..634cb2f 100644 --- a/doc/user/scons_title.xsl +++ b/doc/user/scons_title.xsl @@ -1,31 +1,13 @@ - - @@ -385,14 +367,14 @@ - + - + @@ -436,7 +418,7 @@ - + @@ -471,7 +453,7 @@ - + @@ -513,7 +495,7 @@ - + @@ -4702,7 +4684,7 @@ - + @@ -5585,7 +5567,7 @@ page-position="first"/> - @@ -5607,7 +5589,7 @@ page-position="first"/> - @@ -5619,7 +5601,7 @@ - + @@ -5627,7 +5609,7 @@ page-position="first"/> - @@ -5647,7 +5629,7 @@ page-position="first"/> - @@ -5672,7 +5654,7 @@ - @@ -5788,7 +5770,7 @@ - + @@ -5800,7 +5782,7 @@ - @@ -6003,22 +5985,22 @@ - - - - @@ -6042,7 +6024,7 @@ - @@ -6055,7 +6037,7 @@ - @@ -6063,7 +6045,7 @@ - diff --git a/doc/user/separate.xml b/doc/user/separate.xml index 0485a55..897a126 100644 --- a/doc/user/separate.xml +++ b/doc/user/separate.xml @@ -1,8 +1,8 @@ + + + + %scons; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Declaring Additional Outputs: the &f-SideEffect; Function - - Sometimes the way an action is defined causes effects on files @@ -157,7 +138,7 @@ f1 = env.Command( Unfortunately, the tool which sets up the &b-Program; builder for the MSVC compiler chain does not come prebuilt with an understanding of the details of the .ilk - example - that the target list would need to change + example - that the target list would need to change in the presence of that specific option flag. Unlike the trivial example above where we could simply tell the &Command; builder there were two targets of the action, modifying the diff --git a/doc/user/simple.xml b/doc/user/simple.xml index 6f27b4f..3fa8cea 100644 --- a/doc/user/simple.xml +++ b/doc/user/simple.xml @@ -1,8 +1,8 @@ + + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Handling Common Tasks - - There is a common set of simple tasks that many build configurations rely on as they become more complex. Most build tools have special @@ -122,14 +103,14 @@ env.Append(CPPPATH = "#") env.Append(BUILDERS = {'Copy1' : Builder(action = 'cat < $SOURCE > $TARGET', suffix='.h', src_suffix='.bar')}) -env.Copy1('test.bar') # produces test.h from test.bar. +env.Copy1('test.bar') # produces test.h from test.bar. env.Program('app','main.cpp') # indirectly depends on test.bar ## Source file example env.Append(BUILDERS = {'Copy2' : Builder(action = 'cat < $SOURCE > $TARGET', suffix='.cpp', src_suffix='.bar2')}) -foo = env.Copy2('foo.bar2') # produces foo.cpp from foo.bar2. +foo = env.Copy2('foo.bar2') # produces foo.cpp from foo.bar2. env.Program('app2',['main2.cpp'] + foo) # compiles main2.cpp and foo.cpp into app2. @@ -163,7 +144,7 @@ produces this: scons -Q - + diff --git a/doc/user/tools.xml b/doc/user/tools.xml index 5aa88ea..ac46bab 100644 --- a/doc/user/tools.xml +++ b/doc/user/tools.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Tools - - This appendix contains descriptions of all of the diff --git a/doc/user/troubleshoot.xml b/doc/user/troubleshoot.xml index 24020ab..7a13b64 100644 --- a/doc/user/troubleshoot.xml +++ b/doc/user/troubleshoot.xml @@ -1,4 +1,10 @@ + + + %scons; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Troubleshooting - - The experience of configuring any diff --git a/doc/user/variables.xml b/doc/user/variables.xml index 0677450..27e3323 100644 --- a/doc/user/variables.xml +++ b/doc/user/variables.xml @@ -1,8 +1,14 @@ + + + %scons; - + %builders-mod; @@ -19,31 +25,6 @@ xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 http://www.scons.org/dbxsd/v1.0/scons.xsd"> Construction Variables - - This appendix contains descriptions of all of the diff --git a/doc/user/variants.xml b/doc/user/variants.xml index 5096745..498d82c 100644 --- a/doc/user/variants.xml +++ b/doc/user/variants.xml @@ -1,14 +1,15 @@ - %scons; - + %builders-mod; -- cgit v0.12