diff options
author | Dirk Baechle <dl9obn@darc.de> | 2013-05-03 22:18:52 (GMT) |
---|---|---|
committer | Dirk Baechle <dl9obn@darc.de> | 2013-05-03 22:18:52 (GMT) |
commit | 3c1250527d43864c309cbf0dd2f9356042124d21 (patch) | |
tree | 457872409543640bc391a51c500c510bae145f5e /doc/design | |
parent | 5b4de675705f2cb7aea430e557b9c66475483522 (diff) | |
download | SCons-3c1250527d43864c309cbf0dd2f9356042124d21.zip SCons-3c1250527d43864c309cbf0dd2f9356042124d21.tar.gz SCons-3c1250527d43864c309cbf0dd2f9356042124d21.tar.bz2 |
- switched all docs to SCons XSD
Diffstat (limited to 'doc/design')
-rw-r--r-- | doc/design/MANIFEST | 2 | ||||
-rw-r--r-- | doc/design/acks.xml | 16 | ||||
-rw-r--r-- | doc/design/bground.xml | 16 | ||||
-rw-r--r-- | doc/design/copyright.xml | 14 | ||||
-rw-r--r-- | doc/design/engine.xml | 20 | ||||
-rw-r--r-- | doc/design/goals.xml | 16 | ||||
-rw-r--r-- | doc/design/install.xml | 20 | ||||
-rw-r--r-- | doc/design/intro.xml | 16 | ||||
-rw-r--r-- | doc/design/issues.xml | 16 | ||||
-rw-r--r-- | doc/design/main.xml | 110 | ||||
-rw-r--r-- | doc/design/native.xml | 16 | ||||
-rw-r--r-- | doc/design/overview.xml | 16 | ||||
-rw-r--r-- | doc/design/scons.mod | 429 | ||||
-rw-r--r-- | doc/design/summary.xml | 53 |
14 files changed, 228 insertions, 532 deletions
diff --git a/doc/design/MANIFEST b/doc/design/MANIFEST index 33ab8f0..c477ad9 100644 --- a/doc/design/MANIFEST +++ b/doc/design/MANIFEST @@ -11,4 +11,4 @@ issues.xml main.xml native.xml overview.xml -scons.mod +summary.xml diff --git a/doc/design/acks.xml b/doc/design/acks.xml index b1a8a58..b613c7c 100644 --- a/doc/design/acks.xml +++ b/doc/design/acks.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-acks" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Acknowledgements</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -177,3 +189,5 @@ </varlistentry> </variablelist> + +</chapter> diff --git a/doc/design/bground.xml b/doc/design/bground.xml index c404e86..3a7370e 100644 --- a/doc/design/bground.xml +++ b/doc/design/bground.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-background" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Background</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -84,3 +96,5 @@ it would be a teensy bit easier to type. </para> + +</chapter> diff --git a/doc/design/copyright.xml b/doc/design/copyright.xml index d73906e..ea8a1a3 100644 --- a/doc/design/copyright.xml +++ b/doc/design/copyright.xml @@ -1,6 +1,16 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<legalnotice xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -37,3 +47,5 @@ </para> </blockquote> + +</legalnotice> diff --git a/doc/design/engine.xml b/doc/design/engine.xml index afe9877..e5a61d0 100644 --- a/doc/design/engine.xml +++ b/doc/design/engine.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-engine" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Build Engine API</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -964,7 +976,7 @@ you set it up with another environment... <para> &Builder; objects referenced in the &BUILDERMAP; do not need to be - listed separately in the &BUILDERS; variable. The &consenv; will + listed separately in the <literal>BUILDERS</literal> variable. The &consenv; will bind the union of the &Builder; objects listed in both variables. </para> @@ -1292,7 +1304,7 @@ Comments? <para> &Scanner; objects referenced in the &SCANNERMAP; do not need to - be listed separately in the &SCANNERS; variable. The &consenv; + be listed separately in the <literal>SCANNERS</literal> variable. The &consenv; will bind the union of the &Scanner; objects listed in both variables. @@ -1962,3 +1974,5 @@ I need to write that up... </programlisting> </section> + +</chapter> diff --git a/doc/design/goals.xml b/doc/design/goals.xml index f2e6b7c..3b7598b 100644 --- a/doc/design/goals.xml +++ b/doc/design/goals.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-goals" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Goals</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -214,3 +226,5 @@ To be written. </para> </section> + +</chapter> diff --git a/doc/design/install.xml b/doc/design/install.xml index e670e83..25e4b49 100644 --- a/doc/design/install.xml +++ b/doc/design/install.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-install" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Installation</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -26,3 +38,9 @@ <!-- THIS CHAPTER NEEDS TO BE DISCUSSED AND WRITTEN. --> + +<para> + +</para> + +</chapter> diff --git a/doc/design/intro.xml b/doc/design/intro.xml index 561baa4..296cc67 100644 --- a/doc/design/intro.xml +++ b/doc/design/intro.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-intro" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Introduction</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -109,3 +121,5 @@ I'm especially eager to hear it. --> </section> + +</chapter> diff --git a/doc/design/issues.xml b/doc/design/issues.xml index 1f9a78c..a65a853 100644 --- a/doc/design/issues.xml +++ b/doc/design/issues.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-issues" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Other Issues</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -193,3 +205,5 @@ </para> </section> + +</chapter> diff --git a/doc/design/main.xml b/doc/design/main.xml index e991b36..b01c498 100644 --- a/doc/design/main.xml +++ b/doc/design/main.xml @@ -2,7 +2,7 @@ <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -25,44 +25,19 @@ --> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" -"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ +<!DOCTYPE sconsdoc [ - <!-- - We haven't updated the design document in ages. - Rather than fool people into thinking that it's - actually up-to-date and reflects the current design, - hard-code the version from back when we last updated it. <!ENTITY % version SYSTEM "../version.xml"> %version; - --> - <!ENTITY builddate "2001/12/13 20:55:46"> - <!ENTITY buildversion "0.91"> - <!ENTITY buildrevision "0.01.D177"> - - <!-- - Also freeze the scons.mod DTD extensions - to what they were way back when. + <!ENTITY % scons SYSTEM "../scons.mod"> - --> - <!ENTITY % scons SYSTEM "scons.mod"> %scons; - <!ENTITY acks SYSTEM "acks.xml"> - <!ENTITY bground SYSTEM "bground.xml"> - <!ENTITY copyright SYSTEM "copyright.xml"> - <!ENTITY engine SYSTEM "engine.xml"> - <!ENTITY goals SYSTEM "goals.xml"> - <!ENTITY install SYSTEM "install.xml"> - <!ENTITY intro SYSTEM "intro.xml"> - <!ENTITY issues SYSTEM "issues.xml"> - <!ENTITY native SYSTEM "native.xml"> - <!ENTITY overview SYSTEM "overview.xml"> - ]> -<book> +<book xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> <bookinfo> <title>SCons Design version &buildversion;</title> @@ -80,79 +55,34 @@ <holder>Steven Knight</holder> </copyright> - <legalnotice> - ©right; - </legalnotice> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="copyright.xml"/> <releaseinfo>version &buildversion;</releaseinfo> </bookinfo> - <chapter id="chap-intro"> - <title>Introduction</title> - &intro; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="intro.xml"/> - <chapter id="chap-goals"> - <title>Goals</title> - &goals; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="goals.xml"/> - <chapter id="chap-overview"> - <title>Overview</title> - &overview; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="overview.xml"/> - <chapter id="chap-engine"> - <title>Build Engine API</title> - &engine; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="engine.xml"/> - <chapter id="chap-native"> - <title>Native Python Interface</title> - &native; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="native.xml"/> <!-- - <chapter id="chap-install"> - <title>Installation</title> - &install; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="install.xml"/> --> - <chapter id="chap-issues"> - <title>Other Issues</title> - &issues; - </chapter> - - <chapter id="chap-background"> - <title>Background</title> - &bground; - </chapter> - - <chapter id="chap-summary"> - <title>Summary</title> - <para> - - &SCons; offers a robust and feature-rich design for an SC-build - tool. With a Build Engine based on the proven design of - the &Cons; utility, it offers increased simplification of the - user interface for unsophisticated users with the addition - of the "do-the-right-thing" <function>env.Make</function> - method, increased flexibility for sophisticated users with the - addition of &Builder; and &Scanner; objects, a mechanism to - allow tool-masters (and users) to share working construction - environments, and embeddability to provide reliable dependency - management in a variety of environments and interfaces. - - </para> - </chapter> - - <chapter id="chap-acks"> - <title>Acknowledgements</title> - &acks; - </chapter> + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="issues.xml"/> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="bground.xml"/> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="summary.xml"/> + + <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="acks.xml"/> </book> diff --git a/doc/design/native.xml b/doc/design/native.xml index c665e0c..60be9dd 100644 --- a/doc/design/native.xml +++ b/doc/design/native.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-native" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Native Python Interface</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -362,3 +374,5 @@ beyond what the man page will have. <!-- END HTML --> </section> + +</chapter> diff --git a/doc/design/overview.xml b/doc/design/overview.xml index 266c9e8..72bf583 100644 --- a/doc/design/overview.xml +++ b/doc/design/overview.xml @@ -1,6 +1,18 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-overview" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Overview</title> + <!-- - Copyright (c) 2001, 2002, 2003 Steven Knight + __COPYRIGHT__ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the @@ -496,3 +508,5 @@ This is where it will go, anyway... </section> </section> + +</chapter> diff --git a/doc/design/scons.mod b/doc/design/scons.mod deleted file mode 100644 index 5b246a4..0000000 --- a/doc/design/scons.mod +++ /dev/null @@ -1,429 +0,0 @@ -<!-- - - __COPYRIGHT__ - - An SCons-specific DTD module, for use with SCons DocBook - documentation, that contains names, phrases, acronyms, etc. used - throughout the SCons documentation. - ---> - - - -<!-- - - Other applications that we reference. - ---> - -<!ENTITY Aegis "<application>Aegis</application>"> -<!ENTITY Ant "<application>Ant</application>"> -<!ENTITY Autoconf "<application>Autoconf</application>"> -<!ENTITY Automake "<application>Automake</application>"> -<!ENTITY cc "<application>cc</application>"> -<!ENTITY Cons "<application>Cons</application>"> -<!ENTITY cp "<application>cp</application>"> -<!ENTITY csh "<application>csh</application>"> -<!ENTITY gcc "<application>gcc</application>"> -<!ENTITY Jam "<application>Jam</application>"> -<!ENTITY jar "<application>jar</application>"> -<!ENTITY javac "<application>javac</application>"> -<!ENTITY javah "<application>javah</application>"> -<!ENTITY Make "<application>Make</application>"> -<!ENTITY Makepp "<application>Make++</application>"> -<!ENTITY Python "<application>Python</application>"> -<!ENTITY ranlib "<application>ranlib</application>"> -<!ENTITY rmic "<application>rmic</application>"> -<!ENTITY SCons "<application>SCons</application>"> -<!ENTITY scons "<application>scons</application>"> -<!ENTITY ScCons "<application>ScCons</application>"> -<!ENTITY tar "<application>tar</application>"> -<!ENTITY touch "<application>touch</application>"> -<!ENTITY zip "<application>zip</application>"> - - -<!-- - - Classes. - ---> - -<!ENTITY Action "<classname>Action</classname>"> -<!ENTITY ActionBase "<classname>ActionBase</classname>"> -<!ENTITY CommandAction "<classname>CommandAction</classname>"> -<!ENTITY FunctionAction "<classname>FunctionAction</classname>"> -<!ENTITY ListAction "<classname>ListAction</classname>"> -<!ENTITY Builder "<classname>Builder</classname>"> -<!ENTITY BuilderBase "<classname>BuilderBase</classname>"> -<!ENTITY CompositeBuilder "<classname>CompositeBuilder</classname>"> -<!ENTITY MultiStepBuilder "<classname>MultiStepBuilder</classname>"> -<!ENTITY Job "<classname>Job</classname>"> -<!ENTITY Jobs "<classname>Jobs</classname>"> -<!ENTITY Serial "<classname>Serial</classname>"> -<!ENTITY Parallel "<classname>Parallel</classname>"> -<!ENTITY Node "<classname>Node</classname>"> -<!ENTITY Node_FS "<classname>Node.FS</classname>"> -<!ENTITY Scanner "<classname>Scanner</classname>"> -<!ENTITY Sig "<classname>Sig</classname>"> -<!ENTITY Signature "<classname>Signature</classname>"> -<!ENTITY Taskmaster "<classname>Taskmaster</classname>"> -<!ENTITY TimeStamp "<classname>TimeStamp</classname>"> -<!ENTITY Walker "<classname>Walker</classname>"> -<!ENTITY Wrapper "<classname>Wrapper</classname>"> - - - -<!-- - - Options, command-line. - ---> - -<!ENTITY debug-explain "<literal>--debug=explain</literal>"> -<!ENTITY implicit-cache "<literal>--implicit-cache</literal>"> -<!ENTITY implicit-deps-changed "<literal>--implicit-deps-changed</literal>"> -<!ENTITY implicit-deps-unchanged "<literal>--implicit-deps-unchanged</literal>"> -<!ENTITY Q "<literal>-Q</literal>"> - -<!-- - - Options, SConscript-settable. - ---> - -<!ENTITY implicit_cache "<literal>implicit_cache</literal>"> -<!ENTITY implicit_deps_changed "<literal>implicit_deps_changed</literal>"> -<!ENTITY implicit_deps_unchanged "<literal>implicit_deps_unchanged</literal>"> - - - -<!-- - - File and directory names. - ---> - -<!ENTITY build "<filename>build</filename>"> -<!ENTITY Makefile "<filename>Makefile</filename>"> -<!ENTITY Makefiles "<filename>Makefiles</filename>"> -<!ENTITY SConscript "<filename>SConscript</filename>"> -<!ENTITY SConstruct "<filename>SConstruct</filename>"> -<!ENTITY Sconstruct "<filename>Sconstruct</filename>"> -<!ENTITY sconstruct "<filename>sconstruct</filename>"> -<!ENTITY sconsign "<filename>.sconsign</filename>"> -<!ENTITY src "<filename>src</filename>"> - - - -<!-- - - Methods and functions. This includes functions from both - the Build Engine and the Native Python Interface. - ---> - -<!ENTITY Add "<function>Add</function>"> -<!ENTITY AddOptions "<function>AddOptions</function>"> -<!ENTITY Alias "<function>Alias</function>"> -<!ENTITY Aliases "<function>Aliases</function>"> -<!ENTITY Append "<function>Append</function>"> -<!ENTITY BoolOption "<function>BoolOption</function>"> -<!ENTITY Build "<function>Build</function>"> -<!ENTITY CacheDir "<function>CacheDir</function>"> -<!ENTITY Clean "<function>Clean</function>"> -<!ENTITY Clone "<function>Clone</function>"> -<!ENTITY Command "<function>Command</function>"> -<!ENTITY Configure "<function>Configure</function>"> -<!ENTITY Copy "<function>Copy</function>"> -<!ENTITY Default "<function>Default</function>"> -<!ENTITY DefaultRules "<function>DefaultRules</function>"> -<!ENTITY Depends "<function>Depends</function>"> -<!ENTITY Dir "<function>Dir</function>"> -<!ENTITY Entry "<function>Entry</function>"> -<!ENTITY EnumOption "<function>EnumOption</function>"> -<!ENTITY Environment "<function>Environment</function>"> -<!ENTITY Export "<function>Export</function>"> -<!ENTITY File "<function>File</function>"> -<!ENTITY Finish "<function>Finish</function>"> -<!ENTITY GenerateHelpText "<function>GenerateHelpText</function>"> -<!ENTITY Help "<function>Help</function>"> -<!ENTITY Ignore "<function>Ignore</function>"> -<!ENTITY Import "<function>Import</function>"> -<!ENTITY Install "<function>Install</function>"> -<!ENTITY InstallAs "<function>InstallAs</function>"> -<!ENTITY Link "<function>Link</function>"> -<!ENTITY ListOption "<function>ListOption</function>"> -<!ENTITY Local "<function>Local</function>"> -<!ENTITY Module "<function>Module</function>"> -<!ENTITY NoClean "<function>NoClean</function>"> -<!ENTITY Objects "<function>Objects</function>"> -<!ENTITY Options "<function>Options</function>"> -<!ENTITY PackageOption "<function>PackageOption</function>"> -<!ENTITY PathOption "<function>PathOption</function>"> -<!ENTITY Precious "<function>Precious</function>"> -<!ENTITY Prepend "<function>Prepend</function>"> -<!ENTITY Replace "<function>Replace</function>"> -<!ENTITY Repository "<function>Repository</function>"> -<!ENTITY Return "<function>Return</function>"> -<!ENTITY RuleSet "<function>RuleSet</function>"> -<!ENTITY Salt "<function>Salt</function>"> -<!ENTITY SetBuildSignatureType "<function>SetBuildSignatureType</function>"> -<!ENTITY SetContentSignatureType "<function>SetContentSignatureType</function>"> -<!ENTITY SourceSignature "<function>SourceSignature</function>"> -<!ENTITY SourceSignatures "<function>SourceSignatures</function>"> -<!ENTITY Split "<function>Split</function>"> -<!ENTITY TargetSignatures "<function>TargetSignatures</function>"> -<!ENTITY Task "<function>Task</function>"> - -<!-- Environment methods --> -<!ENTITY subst "<function>subst</function>"> - -<!-- Configure context functions --> -<!ENTITY Message "<function>Message</function>"> -<!ENTITY Result "<function>Result</function>"> -<!ENTITY CheckCHeader "<function>CheckCHeader</function>"> -<!ENTITY CheckCXXHeader "<function>CheckCXXHeader</function>"> -<!ENTITY CheckFunc "<function>CheckFunc</function>"> -<!ENTITY CheckHeader "<function>CheckHeader</function>"> -<!ENTITY CheckLib "<function>CheckLib</function>"> -<!ENTITY CheckLibWithHeader "<function>CheckLibWithHeader</function>"> -<!ENTITY CheckType "<function>CheckType</function>"> -<!ENTITY TryAction "<function>TryAction</function>"> -<!ENTITY TryBuild "<function>TryBuild</function>"> -<!ENTITY TryCompile "<function>TryCompile</function>"> -<!ENTITY TryLink "<function>TryLink</function>"> -<!ENTITY TryRun "<function>TryRun</function>"> - -<!-- Python functions --> -<!ENTITY str "<function>str</function>"> -<!ENTITY zipfile "<function>zipfile</function>"> - -<!-- Obsolete, but referenced in old documents. --> -<!ENTITY Cache "<function>Cache</function>"> - - - -<!-- - - Global variables. - ---> - -<!ENTITY ARGUMENTS "<varname>ARGUMENTS</varname>"> -<!ENTITY BUILD_TARGETS "<varname>BUILD_TARGETS</varname>"> -<!ENTITY COMMAND_LINE_TARGETS "<varname>COMMAND_LINE_TARGETS</varname>"> -<!ENTITY DEFAULT_TARGETS "<varname>DEFAULT_TARGETS</varname>"> - - - -<!-- - - Construction variables. - ---> - -<!ENTITY BUILDERMAP "<varname>BUILDERMAP</varname>"> -<!ENTITY BUILDERS "<varname>BUILDERS</varname>"> -<!ENTITY CC "<varname>CC</varname>"> -<!ENTITY CCFLAGS "<varname>CCFLAGS</varname>"> -<!ENTITY CCCOM "<varname>CCCOM</varname>"> -<!ENTITY COLOR "<varname>COLOR</varname>"> -<!ENTITY COLORS "<varname>COLORS</varname>"> -<!ENTITY CONFIG "<varname>CONFIG</varname>"> -<!ENTITY CPPDEFINES "<varname>CPPDEFINES</varname>"> -<!ENTITY ENV "<varname>ENV</varname>"> -<!ENTITY JAVACLASSDIR "<varname>JAVACLASSDIR</varname>"> -<!ENTITY LIBDIRPREFIX "<varname>LIBDIRPREFIX</varname>"> -<!ENTITY LIBDIRSUFFIX "<varname>LIBDIRSUFFIX</varname>"> -<!ENTITY LIBLINKPREFIX "<varname>LIBLINKPREFIX</varname>"> -<!ENTITY LIBLINKSUFFIX "<varname>LIBLINKSUFFIX</varname>"> -<!ENTITY LIBPATH "<varname>LIBPATH</varname>"> -<!ENTITY LIBS "<varname>LIBS</varname>"> -<!ENTITY LINK "<varname>LINK</varname>"> -<!ENTITY LINKCOM "<varname>LINKCOM</varname>"> -<!ENTITY LINKFLAGS "<varname>LINKFLAGS</varname>"> -<!ENTITY RELEASE "<varname>RELEASE</varname>"> -<!ENTITY RELEASE_BUILD "<varname>RELEASE_BUILD</varname>"> -<!ENTITY SCANNERMAP "<varname>SCANNERMAP</varname>"> -<!ENTITY SCANNERS "<varname>SCANNERS</varname>"> -<!ENTITY TARFLAGS "<varname>TARFLAGS</varname>"> -<!ENTITY TARSUFFIX "<varname>TARSUFFIX</varname>"> - - - -<!-- - - Environment variables. - ---> - -<!ENTITY PATH "<varname>PATH</varname>"> -<!ENTITY PYTHONPATH "<varname>PYTHONPATH</varname>"> -<!ENTITY SCONSFLAGS "<varname>SCONSFLAGS</varname>"> - - - -<!-- - - Function and method arguments. - ---> - -<!ENTITY allowed_values "<varname>allowed_values</varname>"> -<!ENTITY build_dir "<varname>build_dir</varname>"> -<!ENTITY map "<varname>map</varname>"> -<!ENTITY ignorecase "<varname>ignorecase</varname>"> -<!ENTITY options "<varname>options</varname>"> -<!ENTITY exports "<varname>exports</varname>"> -<!ENTITY source "<varname>source</varname>"> -<!ENTITY target "<varname>target</varname>"> - - - -<!-- - - Values of function and method arguments. - ---> - -<!ENTITY all "<literal>all</literal>"> -<!ENTITY none "<literal>none</literal>"> - - - -<!-- - - Builder and Scanner objects. - ---> - -<!ENTITY BuildDir "<function>BuildDir</function>"> -<!ENTITY CFile "<function>CFile</function>"> -<!ENTITY CXXFile "<function>CXXFile</function>"> -<!ENTITY DVI "<function>DVI</function>"> -<!ENTITY Jar "<function>Jar</function>"> -<!ENTITY Java "<function>Java</function>"> -<!ENTITY JavaH "<function>JavaH</function>"> -<!ENTITY Library "<function>Library</function>"> -<!ENTITY Object "<function>Object</function>"> -<!ENTITY PCH "<function>PCH</function>"> -<!ENTITY PDF "<function>PDF</function>"> -<!ENTITY PostScript "<function>PostScript</function>"> -<!ENTITY Program "<function>Program</function>"> -<!ENTITY RES "<function>RES</function>"> -<!ENTITY RMIC "<function>RMIC</function>"> -<!ENTITY SharedLibrary "<function>SharedLibrary</function>"> -<!ENTITY SharedObject "<function>SharedObject</function>"> -<!ENTITY StaticLibrary "<function>StaticLibrary</function>"> -<!ENTITY StaticObject "<function>StaticObject</function>"> -<!ENTITY Tar "<function>Tar</function>"> -<!ENTITY Zip "<function>Zip</function>"> - -<!-- Obsolete, but referenced in old documents. --> -<!ENTITY MakeBuilder "<function>Make</function>"> - - - -<!-- - - Terms. Define both singular and plural forms in various - case-sensitive combinations for use in titles, in-line, etc. - ---> - -<!ENTITY buildfunc "<literal>builder function</literal>"> -<!ENTITY builder_method "<literal>builder method</literal>"> - -<!ENTITY Configure_Contexts "<literal>Configure Contexts</literal>"> -<!ENTITY configure_context "<literal>configure context</literal>"> - -<!ENTITY ConsEnv "<literal>Construction Environment</literal>"> -<!ENTITY ConsEnvs "<literal>Construction Environments</literal>"> -<!ENTITY Consenv "<literal>Construction environment</literal>"> -<!ENTITY Consenvs "<literal>Construction environments</literal>"> -<!ENTITY consenv "<literal>construction environment</literal>"> -<!ENTITY consenvs "<literal>construction environments</literal>"> - -<!ENTITY ConsVar "<literal>Construction Variable</literal>"> -<!ENTITY ConsVars "<literal>Construction Variables</literal>"> -<!ENTITY Consvar "<literal>Construction variable</literal>"> -<!ENTITY Consvars "<literal>Construction variables</literal>"> -<!ENTITY consvar "<literal>construction variable</literal>"> -<!ENTITY consvars "<literal>construction variables</literal>"> - -<!ENTITY CPPPATH "<literal>CPPPATH</literal>"> - -<!ENTITY Dictionary "<literal>Dictionary</literal>"> - -<!ENTITY Emitter "<literal>Emitter</literal>"> -<!ENTITY emitter "<literal>emitter</literal>"> -<!ENTITY Generator "<literal>Generator</literal>"> -<!ENTITY generator "<literal>generator</literal>"> - -<!ENTITY Nodes "<literal>Nodes</literal>"> - -<!ENTITY signature "<literal>signature</literal>"> -<!ENTITY buildsignature "<literal>build signature</literal>"> - -<!ENTITY true "<literal>true</literal>"> -<!ENTITY false "<literal>false</literal>"> - -<!ENTITY typedef "<literal>typedef</literal>"> - -<!-- - - File and program names used in examples. - ---> - -<!ENTITY bar "<application>bar</application>"> -<!ENTITY common1_c "<filename>common1.c</filename>"> -<!ENTITY common2_c "<filename>common2.c</filename>"> -<!ENTITY custom_py "<filename>custom.py</filename>"> -<!ENTITY goodbye "<application>goodbye</application>"> -<!ENTITY goodbye_o "<filename>goodbye.o</filename>"> -<!ENTITY goodbye_obj "<filename>goodbye.obj</filename>"> -<!ENTITY file_dll "<filename>file.dll</filename>"> -<!ENTITY file_in "<filename>file.in</filename>"> -<!ENTITY file_lib "<filename>file.lib</filename>"> -<!ENTITY file_o "<filename>file.o</filename>"> -<!ENTITY file_obj "<filename>file.obj</filename>"> -<!ENTITY file_out "<filename>file.out</filename>"> -<!ENTITY foo "<application>foo</application>"> -<!ENTITY foo_o "<filename>foo.o</filename>"> -<!ENTITY foo_obj "<filename>foo.obj</filename>"> -<!ENTITY hello "<application>hello</application>"> -<!ENTITY hello_c "<filename>hello.c</filename>"> -<!ENTITY hello_exe "<filename>hello.exe</filename>"> -<!ENTITY hello_h "<filename>hello.h</filename>"> -<!ENTITY hello_o "<filename>hello.o</filename>"> -<!ENTITY hello_obj "<filename>hello.obj</filename>"> -<!ENTITY libfile_a "<filename>libfile_a</filename>"> -<!ENTITY libfile_so "<filename>libfile_so</filename>"> -<!ENTITY new_hello "<application>new_hello</application>"> -<!ENTITY new_hello_exe "<application>new_hello.exe</application>"> -<!ENTITY prog "<filename>prog</filename>"> -<!ENTITY prog1 "<filename>prog1</filename>"> -<!ENTITY prog2 "<filename>prog2</filename>"> -<!ENTITY prog_c "<filename>prog.c</filename>"> -<!ENTITY prog_exe "<filename>prog.exe</filename>"> -<!ENTITY stdio_h "<filename>stdio.h</filename>"> - -<!-- - - Punctuation. - ---> - -<!ENTITY plus "<literal>+</literal>"> -<!ENTITY hash "<literal>#</literal>"> - -<!-- - - Mailing lists - ---> - -<!ENTITY scons-announce "<literal>announce@scons.tigris.org</literal>"> -<!ENTITY scons-devel "<literal>dev@scons.tigris.org</literal>"> -<!ENTITY scons-users "<literal>users@scons.tigris.org</literal>"> diff --git a/doc/design/summary.xml b/doc/design/summary.xml new file mode 100644 index 0000000..36e1a90 --- /dev/null +++ b/doc/design/summary.xml @@ -0,0 +1,53 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<chapter id="chap-summary" + xmlns="http://www.scons.org/dbxsd/v1.0" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xsi:schemaLocation="http://www.scons.org/dbxsd/v1.0 scons.xsd"> +<title>Summary</title> + +<!-- + + __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. + +--> + + <para> + + &SCons; offers a robust and feature-rich design for an SC-build + tool. With a Build Engine based on the proven design of + the &Cons; utility, it offers increased simplification of the + user interface for unsophisticated users with the addition + of the "do-the-right-thing" <function>env.Make</function> + method, increased flexibility for sophisticated users with the + addition of &Builder; and &Scanner; objects, a mechanism to + allow tool-masters (and users) to share working construction + environments, and embeddability to provide reliable dependency + management in a variety of environments and interfaces. + + </para> + +</chapter> |