doc/design/main.xml

   1 <?xml version="1.0"?>
   2
   3 <!--
   4
   5   Copyright (c) 2001, 2002, 2003 Steven Knight
   6
   7   Permission is hereby granted, free of charge, to any person obtaining
   8   a copy of this software and associated documentation files (the
   9   "Software"), to deal in the Software without restriction, including
  10   without limitation the rights to use, copy, modify, merge, publish,
  11   distribute, sublicense, and/or sell copies of the Software, and to
  12   permit persons to whom the Software is furnished to do so, subject to
  13   the following conditions:
  14
  15   The above copyright notice and this permission notice shall be included
  16   in all copies or substantial portions of the Software.
  17
  18   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
  19   KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
  20   WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  21   NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  22   LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  23   OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  24   WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  25
  26 -->
  27
  28 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
  29 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
  30 [
  31
  32     <!--
  33     We haven't updated the design document in ages.
  34     Rather than fool people into thinking that it's
  35     actually up-to-date and reflects the current design,
  36     hard-code the version from back when we last updated it.
  37     <!ENTITY % version SYSTEM "../version.xml">
  38     %version;
  39     -->
  40     <!ENTITY builddate "2001/12/13 20:55:46">
  41     <!ENTITY buildversion "0.91">
  42     <!ENTITY buildrevision "0.01.D177">
  43
  44     <!--
  45     Also freeze the scons.mod DTD extensions
  46     to what they were way back when.
  47     <!ENTITY % scons SYSTEM "../scons.mod">
  48     -->
  49     <!ENTITY % scons SYSTEM "scons.mod">
  50     %scons;
  51
  52     <!ENTITY acks SYSTEM "acks.xml">
  53     <!ENTITY bground SYSTEM "bground.xml">
  54     <!ENTITY copyright SYSTEM "copyright.xml">
  55     <!ENTITY engine SYSTEM "engine.xml">
  56     <!ENTITY goals SYSTEM "goals.xml">
  57     <!ENTITY install SYSTEM "install.xml">
  58     <!ENTITY intro SYSTEM "intro.xml">
  59     <!ENTITY issues SYSTEM "issues.xml">
  60     <!ENTITY native SYSTEM "native.xml">
  61     <!ENTITY overview SYSTEM "overview.xml">
  62
  63 ]>
  64
  65 <book>
  66   <bookinfo>
  67     <title>SCons Design version &buildversion;</title>
  68
  69     <author>
  70       <firstname>Steven</firstname>
  71       <surname>Knight</surname>
  72     </author>
  73
  74     <edition>Revision &buildrevision; (&builddate;)</edition>
  75
  76     <pubdate>2001</pubdate>
  77
  78     <copyright>
  79       <year>2001</year>
  80       <holder>Steven Knight</holder>
  81     </copyright>
  82
  83     <legalnotice>
  84       &copyright;
  85     </legalnotice>
  86
  87     <releaseinfo>version &buildversion;</releaseinfo>
  88
  89   </bookinfo>
  90
  91   <chapter id="chap-intro">
  92     <title>Introduction</title>
  93     &intro;
  94   </chapter>
  95
  96   <chapter id="chap-goals">
  97     <title>Goals</title>
  98     &goals;
  99   </chapter>
 100
 101   <chapter id="chap-overview">
 102     <title>Overview</title>
 103     &overview;
 104   </chapter>
 105
 106   <chapter id="chap-engine">
 107     <title>Build Engine API</title>
 108     &engine;
 109   </chapter>
 110
 111   <chapter id="chap-native">
 112     <title>Native Python Interface</title>
 113     &native;
 114   </chapter>
 115
 116   <!--
 117
 118   <chapter id="chap-install">
 119     <title>Installation</title>
 120     &install;
 121   </chapter>
 122
 123   -->
 124
 125   <chapter id="chap-issues">
 126     <title>Other Issues</title>
 127     &issues;
 128   </chapter>
 129
 130   <chapter id="chap-background">
 131     <title>Background</title>
 132     &bground;
 133   </chapter>
 134
 135   <chapter id="chap-summary">
 136     <title>Summary</title>
 137     <para>
 138
 139       &SCons; offers a robust and feature-rich design for an SC-build
 140       tool.  With a Build Engine based on the proven design of
 141       the &Cons; utility, it offers increased simplification of the
 142       user interface for unsophisticated users with the addition
 143       of the "do-the-right-thing" <function>env.Make</function>
 144       method, increased flexibility for sophisticated users with the
 145       addition of &Builder; and &Scanner; objects, a mechanism to
 146       allow tool-masters (and users) to share working construction
 147       environments, and embeddability to provide reliable dependency
 148       management in a variety of environments and interfaces.
 149
 150     </para>
 151   </chapter>
 152
 153   <chapter id="chap-acks">
 154     <title>Acknowledgements</title>
 155     &acks;
 156   </chapter>
 157
 158 </book>