diff options
Diffstat (limited to 'doc/python10/design.xml')
| -rw-r--r-- | doc/python10/design.xml | 143 |
1 files changed, 85 insertions, 58 deletions
diff --git a/doc/python10/design.xml b/doc/python10/design.xml index 0dd5faa..7fe7853 100644 --- a/doc/python10/design.xml +++ b/doc/python10/design.xml @@ -1,22 +1,57 @@ +<?xml version='1.0'?> +<!DOCTYPE sconsdoc [ + <!ENTITY % scons SYSTEM "../scons.mod"> + %scons; +]> + +<section id="sect-design" + 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 scons.xsd"> +<title>Architecture</title> + +<!-- + + Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011, 2012, 2013, 2014 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. + +--> + <para> The &SCons; architecture consists of three layers: </para> +<figure> +<title>&SCons; architecture</title> <mediaobject> <imageobject> - <imagedata fileref="arch" format="eps" align="center"/> - </imageobject> - <imageobject> - <imagedata fileref="arch.jpg" format="jpg" align="center"/> + <imagedata fileref="arch.svg" align="center" scale="50"/> </imageobject> - <!-- PDF files? <imageobject> - <imagedata fileref="arch.pdf" align="center"/> + <imagedata fileref="arch.jpg" align="center"/> </imageobject> - --> </mediaobject> +</figure> <itemizedlist> @@ -164,19 +199,17 @@ </para> + <figure> + <title>Node subsystem</title> <mediaobject> <imageobject> - <imagedata fileref="node" format="eps" align="center"/> - </imageobject> - <imageobject> - <imagedata fileref="node.jpg" format="jpg" align="center"/> + <imagedata fileref="node.svg" align="center" scale="50"/> </imageobject> - <!-- PDF files? <imageobject> - <imagedata fileref="node.pdf" align="center"/> + <imagedata fileref="node.jpg" align="center"/> </imageobject> - --> </mediaobject> + </figure> <para> @@ -228,19 +261,17 @@ </para> + <figure> + <title>Scanner subsystem</title> <mediaobject> <imageobject> - <imagedata fileref="scanner" format="eps" align="center"/> - </imageobject> - <imageobject> - <imagedata fileref="scanner.jpg" format="jpg" align="center"/> + <imagedata fileref="scanner.svg" align="center" scale="50"/> </imageobject> - <!-- PDF files? <imageobject> - <imagedata fileref="scanner.pdf" align="center"/> + <imagedata fileref="scanner.jpg" align="center"/> </imageobject> - --> </mediaobject> + </figure> <para> @@ -270,19 +301,17 @@ </para> + <figure> + <title>Signature subsystem</title> <mediaobject> <imageobject> - <imagedata fileref="sig" format="eps" align="center"/> + <imagedata fileref="sig.svg" align="center" scale="50"/> </imageobject> <imageobject> - <imagedata fileref="sig.jpg" format="jpg" align="center"/> + <imagedata fileref="sig.jpg" align="center"/> </imageobject> - <!-- PDF files? - <imageobject> - <imagedata fileref="sig.pdf" align="center"/> - </imageobject> - --> </mediaobject> + </figure> <para> @@ -326,19 +355,17 @@ </para> + <figure> + <title>Builder subsystem</title> <mediaobject> <imageobject> - <imagedata fileref="builder" format="eps" align="center"/> - </imageobject> - <imageobject> - <imagedata fileref="builder.jpg" format="jpg" align="center"/> + <imagedata fileref="builder.svg" align="center" scale="50"/> </imageobject> - <!-- PDF files? <imageobject> - <imagedata fileref="builder.pdf" align="center"/> + <imagedata fileref="builder.jpg" align="center"/> </imageobject> - --> </mediaobject> + </figure> <para> @@ -389,19 +416,17 @@ </para> + <figure> + <title>Job/Task subsystem</title> <mediaobject> <imageobject> - <imagedata fileref="job-task" format="eps" align="center"/> + <imagedata fileref="job-task.svg" align="center" scale="50"/> </imageobject> <imageobject> - <imagedata fileref="job-task.jpg" format="jpg" align="center"/> + <imagedata fileref="job-task.jpg" align="center"/> </imageobject> - <!-- PDF files? - <imageobject> - <imagedata fileref="job-task.pdf" align="center"/> - </imageobject> - --> </mediaobject> + </figure> <para> @@ -531,8 +556,8 @@ </para> <programlisting> - env = Environment() - env_debug = Environment(CCFLAGS = '-g') +env = Environment() +env_debug = Environment(CCFLAGS = '-g') </programlisting> </section> @@ -547,7 +572,7 @@ file, a library, etc. A &Builder; object is associated with a file through an associated &consenv; method and later invoked to actually build the file. The &Builder; object will typically use - construction variables (such as &CCFLAGS;, &LIBPATH;) to influence + construction variables (such as <literal>CCFLAGS</literal>, <literal>LIBPATH</literal>) to influence the specific build execution. </para> @@ -559,7 +584,7 @@ </para> <programlisting> - bld = Builder(name = 'Program', action = "$CC -o $TARGET $SOURCES") +bld = Builder(name = 'Program', action = "$CC -o $TARGET $SOURCES") </programlisting> <para> @@ -608,8 +633,8 @@ </para> <programlisting> - bld_lib = Builder(name = 'Library', action = "$AR r $TARGET $SOURCES", - prefix = 'lib', suffix = '.a', src_suffix = '.o') +bld_lib = Builder(name = 'Library', action = "$AR r $TARGET $SOURCES", + prefix = 'lib', suffix = '.a', src_suffix = '.o') </programlisting> <para> @@ -629,13 +654,13 @@ <para> &Builder; objects are associated with a &consenv; through a - &consvar; named &BUILDERS;, a list of the &Builder; objects that + &consvar; named <literal>BUILDERS</literal>, a list of the &Builder; objects that will be available for execution through the &consenv;: </para> <programlisting> - env = Environment(BUILDERS = [ Object, Library, WebPage, Program ]) +env = Environment(BUILDERS = [ Object, Library, WebPage, Program ]) </programlisting> </section> @@ -678,13 +703,13 @@ <para> &Scanner; objects are associated with a &consenv; through a - &consvar; named &SCANNERS;, a list of the &Scanner; objects that + &consvar; named <literal>SCANNERS</literal>, a list of the &Scanner; objects that will be available through the &consenv;: </para> <programlisting> - env = Environment(SCANNERS = [ CScan, M4Scan ]) +env = Environment(SCANNERS = [ CScan, M4Scan ]) </programlisting> <para> @@ -720,7 +745,7 @@ </para> <programlisting> - BuildDir(source = 'src', build = 'bld') +BuildDir(source = 'src', build = 'bld') </programlisting> <para> @@ -738,7 +763,7 @@ </para> <programlisting> - BuildDir(source = 'src', build = 'bld', no_sources = 1) +BuildDir(source = 'src', build = 'bld', no_sources = 1) </programlisting> </section> @@ -759,7 +784,7 @@ </para> <programlisting> - Repository('/home/source/1.1', '/home/source/1.0') +Repository('/home/source/1.1', '/home/source/1.0') </programlisting> <para> @@ -785,7 +810,7 @@ </para> <programlisting> - Cache('/var/build.cache/i386') +Cache('/var/build.cache/i386') </programlisting> <para> @@ -855,7 +880,7 @@ </para> <programlisting> - source_files = 'f1.c f2.c f3.c' +source_files = 'f1.c f2.c f3.c' </programlisting> <para> @@ -867,7 +892,7 @@ </para> <programlisting> - SConscript('src/SConscript', 'lib/SConscript') +SConscript('src/SConscript', 'lib/SConscript') </programlisting> <para> @@ -896,3 +921,5 @@ </para> </section> + +</section> |