Fix XML in documentation, and in the bin/scons-doc.py script that generates
[scons.git] / doc / python10 / 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     <!ENTITY % scons SYSTEM "scons.mod">
33     %scons;
34
35     <!ENTITY abstract SYSTEM "abstract.xml">
36     <!ENTITY acks SYSTEM "acks.xml">
37     <!ENTITY copyright SYSTEM "copyright.xml">
38     <!ENTITY design SYSTEM "design.xml">
39     <!ENTITY future SYSTEM "future.xml">
40     <!ENTITY install SYSTEM "install.xml">
41     <!ENTITY intro SYSTEM "intro.xml">
42     <!ENTITY process SYSTEM "process.xml">
43
44 ]>
45
46 <article>
47   <articleinfo>
48     <title>SCons Design and Implementation</title>
49
50     <author>
51       <firstname>Steven</firstname>
52       <surname>Knight</surname>
53     </author>
54
55     <copyright>
56       <year>2001</year>
57       <year>2002</year>
58       <holder>Steven Knight</holder>
59     </copyright>
60
61     <pubdate>2002</pubdate>
62
63     <confgroup>
64       <confdates>4-7 February 2002</confdates>
65       <conftitle>The Tenth International Python Conference</conftitle>
66       <address>Alexandria, Virginia</address>
67     </confgroup>
68
69     <revhistory>
70       <revision>
71         <revnumber>0.2</revnumber>
72         <date>16 December 2001</date>
73         <revremark>Internal re-review.</revremark>
74       </revision>
75       <revision>
76         <revnumber>0.1</revnumber>
77         <date>8 October 2001</date>
78         <revremark>Submitted for Python10 conference.</revremark>
79       </revision>
80     </revhistory>
81
82   </articleinfo>
83
84   <abstract>
85     &abstract;
86   </abstract>
87
88   <section id="sect-intro">
89     <title>Introduction</title>
90     &intro;
91   </section>
92
93   <section id="sect-design">
94     <title>Architecture</title>
95     &design;
96   </section>
97
98   <section id="sect-install">
99     <title>Installation</title>
100     &install;
101   </section>
102
103   <section id="sect-process">
104     <title>Development Process</title>
105     &process;
106   </section>
107
108   <section id="sect-future">
109     <title>Future Directions</title>
110     &future;
111   </section>
112
113   <section id="sect-summary">
114     <title>Summary</title>
115     <para>
116
117       This paper has introduced &SCons;, a next-generation build tool
118       with a modular, embeddable architecture and a direct Python
119       interface. &SCons; has a global view of the dependencies in a source
120       tree, uses MD5 signatures to decide if derived files are out of date,
121       and automatically scans files for dependencies, all of which make &SCons;
122       builds exceptionally reliable. The &SCons; development methodology has
123       been described, notable for its emphasis on automated regression
124       testing to ensure a robust and reliable tool from day one. Several
125       future directions for &SCons; have also been discussed.
126
127     </para>
128   </section>
129
130   <section id="sect-acks">
131     <title>Acknowledgements</title>
132     &acks;
133   </section>
134
135   <!--
136   <section id="sect-refs">
137     <title>References</title>
138     <para>
139     </para>
140   </section>
141   -->
142
143   <bibliography id="sect-refs">
144     <title>References</title>
145
146     <biblioentry>
147       <abbrev>1</abbrev>
148       <authorgroup>
149         <author><firstname>Stuart I.</firstname><surname>Feldman</surname></author>
150       </authorgroup>
151       <copyright>
152         <year>Aug 1978</year>
153       </copyright>
154       <publisher>
155         <publishername>Bell Laboratories</publishername>
156       </publisher>
157       <title>Make - A Program for Maintaining Computer Programs</title>
158     </biblioentry>
159
160     <biblioentry>
161       <abbrev>2</abbrev>
162       <authorgroup>
163         <author><firstname>Peter</firstname><surname>Miller</surname></author>
164       </authorgroup>
165       <copyright>
166         <year>1997</year>
167         <holder>Peter Miller</holder>
168       </copyright>
169       <title>Recursive Make Considered Harmful</title>
170       <!--http://www.pcug.org.au/~millerp/rmch/recu-make-cons-harm.html-->
171     </biblioentry>
172
173     <biblioentry>
174       <abbrev>3</abbrev>
175       <authorgroup>
176         <author><firstname>Andrew</firstname><surname>Oram</surname></author>
177         <author><firstname>Steve</firstname><surname>Talbott</surname></author>
178       </authorgroup>
179       <copyright>
180         <year>1986</year>
181         <year>1991</year>
182         <holder>O'Reilly &amp; Associates, Inc.</holder>
183       </copyright>
184       <publisher>
185         <publishername>O'Reilly &amp; Associates, Inc.</publishername>
186       </publisher>
187       <title>Managing Projects with Make, 2nd Ed.</title>
188     </biblioentry>
189
190     <biblioentry>
191       <abbrev>4</abbrev>
192       <authorgroup>
193         <author><firstname>Richard M.</firstname><surname>Stallman</surname></author>
194         <author><firstname>Roland</firstname><surname>McGrath</surname></author>
195       </authorgroup>
196       <copyright>
197         <year>1988</year>
198         <year>'89</year>
199         <year>'90</year>
200         <year>'91</year>
201         <year>'92</year>
202         <year>'93</year>
203         <year>'94</year>
204         <year>'95</year>
205         <year>'96</year>
206         <year>'97</year>
207         <year>'98</year>
208         <year>'99</year>
209         <year>2000</year>
210         <holder>Free Software Foundation, Inc.</holder>
211       </copyright>
212       <publisher>
213         <publishername>Free Software Foundation, Inc.</publishername>
214       </publisher>
215       <title>GNU Make</title>
216       <subtitle>A Program for Directing Recompilation</subtitle>
217     </biblioentry>
218
219   </bibliography>
220
221 </article>