summaryrefslogtreecommitdiffstats
path: root/doc/design
diff options
context:
space:
mode:
authorSteven Knight <knight@baldmt.com>2007-08-17 03:17:04 (GMT)
committerSteven Knight <knight@baldmt.com>2007-08-17 03:17:04 (GMT)
commit8cb34cccc26935bce5d07ed3f51cc29fbbd1ab03 (patch)
tree7bc281e44fe45cae35656e0e457fef8f308fbb7b /doc/design
parent5b4b4c6e5384712ab1835bdcf8beea09611b6e62 (diff)
downloadSCons-8cb34cccc26935bce5d07ed3f51cc29fbbd1ab03.zip
SCons-8cb34cccc26935bce5d07ed3f51cc29fbbd1ab03.tar.gz
SCons-8cb34cccc26935bce5d07ed3f51cc29fbbd1ab03.tar.bz2
Merged revisions 2136-2200,2202-2290,2292-2301 via svnmerge from
http://scons.tigris.org/svn/scons/branches/core ........ r2145 | stevenknight | 2007-07-17 09:15:12 -0500 (Tue, 17 Jul 2007) | 3 lines Don't put null strings (from variable expansion) in a path list. (They get turned into the current directory on later expansion.) ........ r2146 | stevenknight | 2007-07-17 10:47:39 -0500 (Tue, 17 Jul 2007) | 3 lines Add support for optional arguments on command-line long options by specifying nargs='?'. ........ r2149 | stevenknight | 2007-07-17 15:22:24 -0500 (Tue, 17 Jul 2007) | 2 lines Remove left-over Optik mentions. ........ r2150 | stevenknight | 2007-07-17 15:39:34 -0500 (Tue, 17 Jul 2007) | 4 lines Add a $SWIGPATH variable for finding SWIG dependencies, with $SWIGINC{PREFIX,SUFFIX} for adding them to the command line. ........ r2154 | stevenknight | 2007-07-18 20:05:31 -0500 (Wed, 18 Jul 2007) | 2 lines Fix variable misspellings in the doc added for $SWIGOUTPUT. ........ r2155 | stevenknight | 2007-07-18 20:07:28 -0500 (Wed, 18 Jul 2007) | 2 lines Add the Python eggs info file to the RPM packaging build. ........ r2156 | stevenknight | 2007-07-18 20:15:08 -0500 (Wed, 18 Jul 2007) | 2 lines Convert documentation from DocBook SGML to XML. ........ r2158 | stevenknight | 2007-07-19 17:16:19 -0500 (Thu, 19 Jul 2007) | 3 lines Conditionally add the .egg-info the RPM file list only if the distutils in the version of Python that rpmbuild will execute knows about them. ........ r2161 | stevenknight | 2007-07-19 19:12:29 -0500 (Thu, 19 Jul 2007) | 5 lines Capture a test case (contributed by Tilo Prutz) where instantiation of a private class causes javac to generate an additional anonymous inner class file. (No solution yet, but there's no sense throwing away the preparatory work.) ........ r2162 | stevenknight | 2007-07-20 11:29:56 -0500 (Fri, 20 Jul 2007) | 3 lines Support passing a list of .java files as source to the Java() builder. (Leanid Nazdrynau) ........ r2163 | garyo | 2007-07-20 12:00:35 -0500 (Fri, 20 Jul 2007) | 1 line Fixed cut-n-paste error in Touch factory method doc in users guide. ........ r2167 | stevenknight | 2007-07-21 22:59:40 -0500 (Sat, 21 Jul 2007) | 2 lines Don't execute the SWIGOUTDIR test if swig isn't installed. ........ r2168 | stevenknight | 2007-07-21 23:14:17 -0500 (Sat, 21 Jul 2007) | 2 lines Fix the test's ability to run under a path name containing spaces. ........ r2171 | stevenknight | 2007-07-24 15:54:41 -0500 (Tue, 24 Jul 2007) | 2 lines Handle white space in key file names in the packaging build. ........ r2172 | stevenknight | 2007-07-24 21:41:15 -0500 (Tue, 24 Jul 2007) | 2 lines More efficient copying of construction environments. ........ r2173 | stevenknight | 2007-07-25 10:56:02 -0500 (Wed, 25 Jul 2007) | 2 lines Update the SCons build for Subversion and general clean-up. ........ r2174 | stevenknight | 2007-07-25 11:35:16 -0500 (Wed, 25 Jul 2007) | 3 lines Suppress the [brackets] around a node in the --tree=prune output if the node is a source. ........ r2175 | stevenknight | 2007-07-25 12:52:18 -0500 (Wed, 25 Jul 2007) | 3 lines Commonize the skip_test() method and make its behavior configurable via a TESTCOMMON_PASS_SKIPS environment variable. ........ r2178 | stevenknight | 2007-07-25 21:43:47 -0500 (Wed, 25 Jul 2007) | 3 lines Add $JAVACLASSPATH and $JAVASOURCEPATH construction variables. (Leanid Nazdrynau) ........ r2182 | stevenknight | 2007-07-30 12:10:20 -0500 (Mon, 30 Jul 2007) | 3 lines Refactor Builder suffix-adjusting into its own method, so we can (potentially) re-use it for Builders with attached source Builders. ........ r2183 | stevenknight | 2007-07-30 14:51:53 -0500 (Mon, 30 Jul 2007) | 2 lines More efficient source-builder suffix matching. ........ r2184 | stevenknight | 2007-07-30 16:01:42 -0500 (Mon, 30 Jul 2007) | 4 lines Encapsulate initialization of the default FS object by an accessor function in SCons.Node.FS. (This also gets rid of an unnecessary reference to SCons.Node.FS.default_fs in the LaTeX scanner.) ........ r2193 | stevenknight | 2007-07-30 18:24:07 -0500 (Mon, 30 Jul 2007) | 3 lines Fix interpretation of source arguments that have no suffix when the called Builder has both a src_suffix and a src_builder. ........ r2194 | stevenknight | 2007-07-31 10:25:31 -0500 (Tue, 31 Jul 2007) | 2 lines Increase the number of tries for random output from three to ten. ........ r2195 | stevenknight | 2007-07-31 10:52:28 -0500 (Tue, 31 Jul 2007) | 3 lines Skip the test gracefully if the zipfile module can't read the file it just wrote (which is the case for Python 2.1 on 64-bit systems). ........ r2196 | stevenknight | 2007-07-31 13:06:21 -0500 (Tue, 31 Jul 2007) | 2 lines Move the "import zipfile" so it doesn't fail on Python <= 2.0. ........ r2197 | stevenknight | 2007-07-31 14:51:50 -0500 (Tue, 31 Jul 2007) | 3 lines Commonize initialization of the various Java builders so they can be hooked up into a multi-stage Builder chain. (Leanid Nazdrynau) ........ r2198 | stevenknight | 2007-07-31 16:15:18 -0500 (Tue, 31 Jul 2007) | 3 lines Fix use of ${TARGET.dir} and ${SOURCE.dir} expansions in $FORTRANMODDIR $JARCHDIR, $JARFLAGS, $LEXFLAGS, $SWIGFLAGS, $SWIGOUTDIR and $YACCFLAGS. ........ r2199 | stevenknight | 2007-07-31 16:25:48 -0500 (Tue, 31 Jul 2007) | 2 lines Remove left-over Trace() call. ........ r2202 | stevenknight | 2007-08-01 12:31:48 -0500 (Wed, 01 Aug 2007) | 3 lines Bail out via test.skip_test() if wix ("candle") isn't found. Put the main body of code flush left instead of under an if: block. ........ r2203 | stevenknight | 2007-08-01 15:35:55 -0500 (Wed, 01 Aug 2007) | 5 lines Fix Tool.packaging.rpm.package() so it doesn't always overwrite $RPMFLAGS with -ta. Set --buildroot in RPM packaging tests so they don't overwrite each other when run simultaneously. ........ r2204 | stevenknight | 2007-08-01 15:37:36 -0500 (Wed, 01 Aug 2007) | 2 lines Fix a nested scope issue with the internal build_sources() function. ........ r2205 | stevenknight | 2007-08-01 15:46:08 -0500 (Wed, 01 Aug 2007) | 5 lines Normalize (X out) the CreationDate field inside embedded, compressed PostScript streams within the generated PDF files. Also normalize preceding Length field, since compression length is affected by different patterns of input, including the variable CreationDate value. ........ r2211 | stevenknight | 2007-08-02 08:52:06 -0500 (Thu, 02 Aug 2007) | 2 lines Add the new modules from branches/packaging to the SCons packaging build. ........ r2212 | stevenknight | 2007-08-02 19:59:01 -0500 (Thu, 02 Aug 2007) | 2 lines Fix the JAVACLASSPATH test when javah isn't on the default $PATH. ........ r2214 | stevenknight | 2007-08-03 15:05:21 -0500 (Fri, 03 Aug 2007) | 4 lines Hook up the Java builders into a multi-step chain underneath a Java() pseudo-builder (wrapper) that examines its arguments and calls the appropriate underlying file-or-dir builder. ........ r2215 | stevenknight | 2007-08-03 15:49:58 -0500 (Fri, 03 Aug 2007) | 2 lines Fix for old Python versions: use apply() instead of *args, **kw. ........ r2216 | stevenknight | 2007-08-03 16:49:31 -0500 (Fri, 03 Aug 2007) | 2 lines Hook up the SWIG builder as a source builder for .java files. ........ r2217 | stevenknight | 2007-08-03 17:28:19 -0500 (Fri, 03 Aug 2007) | 2 lines Don't use .endswith(), which didn't appear until later Python versions. ........ r2218 | stevenknight | 2007-08-03 17:29:38 -0500 (Fri, 03 Aug 2007) | 2 lines Replace tabs with spaces. ........ r2219 | stevenknight | 2007-08-04 08:06:23 -0500 (Sat, 04 Aug 2007) | 3 lines Initialize a loop-invariant lambda for matching .java suffixes outside the loop. ........ r2220 | stevenknight | 2007-08-07 15:06:13 -0500 (Tue, 07 Aug 2007) | 2 lines Refactor parallel class-generation loops into one. ........ r2221 | stevenknight | 2007-08-07 16:04:06 -0500 (Tue, 07 Aug 2007) | 5 lines Have the Java multi-step builder test actually check for generated files, and fix the generation of .java and .class file names, and interaction with the SWIG builder, so that the files are generated in the correct place. ........ r2222 | stevenknight | 2007-08-07 16:45:05 -0500 (Tue, 07 Aug 2007) | 3 lines Fix dependencies on SWIG-generated .java files so they don't have to be built in multiple passes. ........ r2226 | stevenknight | 2007-08-07 18:00:22 -0500 (Tue, 07 Aug 2007) | 2 lines Fix SWIG when used with BuildDir(). ........ r2227 | stevenknight | 2007-08-07 22:15:55 -0500 (Tue, 07 Aug 2007) | 5 lines User's guide updates: - Make the multiple files example match its text. - Expand a truncated sentence about being able to use Python function actions in the Command() Builder. ........ r2228 | stevenknight | 2007-08-07 23:25:18 -0500 (Tue, 07 Aug 2007) | 3 lines Don't generate an error if a #include file matches a same-named directory in $CPPPATH (or $FORTRANPATH, etc.). ........ r2229 | stevenknight | 2007-08-07 23:40:00 -0500 (Tue, 07 Aug 2007) | 2 lines Fix a code example. (Gary Oberbrunner) ........ r2230 | stevenknight | 2007-08-08 00:05:43 -0500 (Wed, 08 Aug 2007) | 3 lines Capture a test case to make sure AddPostAction() doesn't interfere with normal linking. (Matt Doar, Gary Oberbrunner) ........ r2233 | stevenknight | 2007-08-08 14:15:44 -0500 (Wed, 08 Aug 2007) | 2 lines Fix documentation typo in a construction variable cross-reference. ........ r2234 | stevenknight | 2007-08-08 17:03:25 -0500 (Wed, 08 Aug 2007) | 2 lines Changes to SCons packaging to support checkpoint releases. ........ r2235 | stevenknight | 2007-08-09 10:10:01 -0500 (Thu, 09 Aug 2007) | 2 lines Sidestep false negatives on heavily loaded systems. ........ r2236 | garyo | 2007-08-09 11:16:26 -0500 (Thu, 09 Aug 2007) | 1 line Allow unpackaged files (e.g. *.pyo) to exist in the build dir without being packaged in the RPM. Without this, on some systems the rpmbuild may error out. ........ r2237 | stevenknight | 2007-08-09 11:27:56 -0500 (Thu, 09 Aug 2007) | 5 lines Fix test/SWIG/build-dir.py so it works on old Python versions without distutils.sysconfig. Instead of just cutting-and-pasting initialization code from other SWIG tests, centralize it in some new TestSCons methods. ........ r2238 | garyo | 2007-08-09 11:30:58 -0500 (Thu, 09 Aug 2007) | 1 line Use docbook 4.3 instead of 4.4 for the XML doctype since some older(?) jade parsers can't handle new 4-byte Unicode chars in the 4.4 version of isogrk4.ent. ........ r2240 | stevenknight | 2007-08-09 16:35:06 -0500 (Thu, 09 Aug 2007) | 2 lines User's Guide updates (post packaging changes). ........ r2243 | stevenknight | 2007-08-10 10:31:51 -0500 (Fri, 10 Aug 2007) | 3 lines Fix the User's Guide build to use openjade, and to accomodate a change in the name of the main generated file (book1.html => index.html). ........ r2245 | stevenknight | 2007-08-10 11:09:16 -0500 (Fri, 10 Aug 2007) | 2 lines Update the {CHANGES,RELEASE}.txt datestamp lines. ........ r2253 | stevenknight | 2007-08-10 16:21:54 -0500 (Fri, 10 Aug 2007) | 2 lines Fix the wix Tool module's ability to handle null entries in $PATH. ........ r2261 | stevenknight | 2007-08-11 23:08:12 -0500 (Sat, 11 Aug 2007) | 3 lines Remove unnecessary files (.svnt/*, .{ae,cvs}ignore, www/*) from the scons-src packages. ........ r2262 | stevenknight | 2007-08-11 23:24:49 -0500 (Sat, 11 Aug 2007) | 2 lines Add missing __revision__ lines. ........ r2263 | stevenknight | 2007-08-11 23:33:42 -0500 (Sat, 11 Aug 2007) | 2 lines Skip the test if the MANIFEST file hasn't been built. ........ r2264 | stevenknight | 2007-08-11 23:36:30 -0500 (Sat, 11 Aug 2007) | 2 lines Add recent compatibility modules to the relevant exceptions lists. ........ r2265 | stevenknight | 2007-08-11 23:39:00 -0500 (Sat, 11 Aug 2007) | 3 lines Update __VERSION__ strings in the QMTest/*.py modules, so that packaging tests (src/test_*.py) will pass after builds of checkpoint releases. ........ r2266 | stevenknight | 2007-08-12 07:36:19 -0500 (Sun, 12 Aug 2007) | 2 lines Add a comment about why we construct the __VERSION__ string at run time. ........ r2267 | stevenknight | 2007-08-12 07:42:30 -0500 (Sun, 12 Aug 2007) | 2 lines Avoid reading the MANIFEST file twice. (Courtesy review by Greg Noel.) ........ r2268 | stevenknight | 2007-08-12 08:14:53 -0500 (Sun, 12 Aug 2007) | 3 lines Shift Install() and InstallAs() from being documented as functions to being documented as Builders. ........ r2269 | garyo | 2007-08-13 08:49:52 -0500 (Mon, 13 Aug 2007) | 1 line Tests: Skip some more Java tests if javac is not installed on the test machine so they don't get marked as failing. ........ r2270 | garyo | 2007-08-13 11:09:39 -0500 (Mon, 13 Aug 2007) | 1 line Fixed typo in test (shows up on non-Linux platforms). ........ r2271 | garyo | 2007-08-13 14:09:05 -0500 (Mon, 13 Aug 2007) | 4 lines Test portability fixes for Darwin/OSX and IRIX. This does not make all the tests pass on those OSes, but it takes care of some of the more obvious errors that I have time for right now. More to come. ........ r2272 | stevenknight | 2007-08-13 15:33:29 -0500 (Mon, 13 Aug 2007) | 2 lines Tab => space fix. ........ r2273 | stevenknight | 2007-08-13 15:33:52 -0500 (Mon, 13 Aug 2007) | 2 lines Test for swig, too, which is used to build from the .i file. ........ r2277 | garyo | 2007-08-14 10:40:00 -0500 (Tue, 14 Aug 2007) | 8 lines Test portability on IRIX: test/Actions/pre-post creates target file before building target, then IRIX CC does not chmod +x afterwards. I think this change is safe on all OSes. test/AS/ml.py: I think this is only supposed to be run on win32 (not skipped only on win32); the sense of the skip test was backwards. ........ r2278 | stevenknight | 2007-08-14 11:04:40 -0500 (Tue, 14 Aug 2007) | 2 lines Add -tt when running tests, to catch inconsistent tab usage. ........ r2279 | stevenknight | 2007-08-14 14:00:43 -0500 (Tue, 14 Aug 2007) | 2 lines Minor refactor of logic in File.retrieve_from_cache(). ........ r2280 | stevenknight | 2007-08-15 01:11:40 -0500 (Wed, 15 Aug 2007) | 2 lines Refactor CacheDir support into its own module. ........ r2281 | stevenknight | 2007-08-15 07:24:51 -0500 (Wed, 15 Aug 2007) | 2 lines Move the cachepath() method from FS.File to the CacheDir class. ........ r2282 | stevenknight | 2007-08-15 08:31:34 -0500 (Wed, 15 Aug 2007) | 2 lines Python 1.5.2 fix in the new Null class. ........ r2283 | stevenknight | 2007-08-15 10:45:53 -0500 (Wed, 15 Aug 2007) | 5 lines Refactor CacheDir unit tests to: - restore functionality that was dropped in the transition; - commonize creation of test Nodes and other (mock) objects - separate CacheDir tests from tests of CacheDir through Node.FS.File. ........ r2284 | stevenknight | 2007-08-15 11:46:38 -0500 (Wed, 15 Aug 2007) | 3 lines Replace the Executor.Null.NullEnvironment object with a real Null object, so it will absorb the CacheDir method calls as well. ........ r2285 | stevenknight | 2007-08-15 11:52:57 -0500 (Wed, 15 Aug 2007) | 5 lines Add a get_CacheDir() method to a construction environment, which will be used to fetch per-environment CacheDir specifications. (Right now all calls to it still just return the one attached to underlying default FS object.) ........ r2286 | stevenknight | 2007-08-15 15:15:46 -0500 (Wed, 15 Aug 2007) | 2 lines Support per-construction-environment configuration of CacheDir(). ........ r2287 | stevenknight | 2007-08-15 15:33:04 -0500 (Wed, 15 Aug 2007) | 2 lines Move the tests of CacheDir()-related command-line options into test/CacheDir. ........ r2293 | stevenknight | 2007-08-16 11:14:49 -0500 (Thu, 16 Aug 2007) | 3 lines Add the Package() builder description to the documentation build, fixing the XML so that it will build. ........ r2294 | stevenknight | 2007-08-16 12:51:19 -0500 (Thu, 16 Aug 2007) | 3 lines Reorganize packaging documentation: alphabetize the variable definitions (and function names), document Tag() as a function, not a builder. ........ r2296 | stevenknight | 2007-08-16 12:55:01 -0500 (Thu, 16 Aug 2007) | 2 lines Add a build command. ........ r2300 | stevenknight | 2007-08-16 16:49:13 -0500 (Thu, 16 Aug 2007) | 2 lines First cut at documenting packaging variables. ........ r2301 | stevenknight | 2007-08-16 16:51:21 -0500 (Thu, 16 Aug 2007) | 3 lines Construct the .src.rpm and .arch.rpm file names independnetly, not by trying to massage one into the other. ........
Diffstat (limited to 'doc/design')
-rw-r--r--doc/design/MANIFEST22
-rw-r--r--doc/design/acks.xml (renamed from doc/design/acks.sgml)0
-rw-r--r--doc/design/bground.xml (renamed from doc/design/bground.sgml)0
-rw-r--r--doc/design/copyright.xml (renamed from doc/design/copyright.sgml)0
-rw-r--r--doc/design/engine.xml (renamed from doc/design/engine.sgml)44
-rw-r--r--doc/design/goals.xml (renamed from doc/design/goals.sgml)16
-rw-r--r--doc/design/install.xml (renamed from doc/design/install.sgml)4
-rw-r--r--doc/design/intro.xml (renamed from doc/design/intro.sgml)4
-rw-r--r--doc/design/issues.xml (renamed from doc/design/issues.sgml)0
-rw-r--r--doc/design/main.xml (renamed from doc/design/main.sgml)31
-rw-r--r--doc/design/native.xml (renamed from doc/design/native.sgml)8
-rw-r--r--doc/design/overview.xml (renamed from doc/design/overview.sgml)4
12 files changed, 74 insertions, 59 deletions
diff --git a/doc/design/MANIFEST b/doc/design/MANIFEST
index 3fb99f0..33ab8f0 100644
--- a/doc/design/MANIFEST
+++ b/doc/design/MANIFEST
@@ -1,14 +1,14 @@
-acks.sgml
-bground.sgml
-copyright.sgml
+acks.xml
+bground.xml
+copyright.xml
engine.fig
engine.jpg
-engine.sgml
-goals.sgml
-install.sgml
-intro.sgml
-issues.sgml
-main.sgml
-native.sgml
-overview.sgml
+engine.xml
+goals.xml
+install.xml
+intro.xml
+issues.xml
+main.xml
+native.xml
+overview.xml
scons.mod
diff --git a/doc/design/acks.sgml b/doc/design/acks.xml
index b1a8a58..b1a8a58 100644
--- a/doc/design/acks.sgml
+++ b/doc/design/acks.xml
diff --git a/doc/design/bground.sgml b/doc/design/bground.xml
index c404e86..c404e86 100644
--- a/doc/design/bground.sgml
+++ b/doc/design/bground.xml
diff --git a/doc/design/copyright.sgml b/doc/design/copyright.xml
index d73906e..d73906e 100644
--- a/doc/design/copyright.sgml
+++ b/doc/design/copyright.xml
diff --git a/doc/design/engine.sgml b/doc/design/engine.xml
index df78e3b..1a1e335 100644
--- a/doc/design/engine.sgml
+++ b/doc/design/engine.xml
@@ -523,7 +523,7 @@
</tgroup>
</informaltable>
-<REMARK>
+<!--
&Library; and &SharedLibrary; have nearly identical
semantics, just different
tools and &consenvs (paths, etc.) that they use.
@@ -532,7 +532,7 @@ using just the &Library; &Builder; object
with a different environment.
I think that's a better way to do it.
Feedback?
-</REMARK>
+-->
<para>
@@ -671,9 +671,9 @@ Feedback?
&Builder; objects raise the following exceptions on error:
- <REMARK>
+ <!--
LIST THESE ONCE WE FIGURE OUT WHAT THEY ARE FROM CODING THEM.
- </REMARK>
+ -->
</para>
</section>
@@ -735,9 +735,9 @@ Feedback?
</para>
- <REMARK>
+ <!--
NEED AN EXAMPLE HERE.
- </REMARK>
+ -->
<para>
@@ -918,7 +918,7 @@ Feedback?
<section>
<title>&Builder; maps</title>
-<REMARK>
+<!--
Do we even need this anymore?
Now that the individual builders
have specified <literal>suffix</literal>
@@ -929,7 +929,7 @@ I think this is a holdover from before I
added the <literal>suffix</literal> arguments.
If you want &MakeBuilder; to do something different,
you set it up with another environment...
-</REMARK>
+-->
<para>
@@ -1264,13 +1264,13 @@ you set it up with another environment...
<section>
<title>&Scanner; maps</title>
-<REMARK>
+<!--
If the &BUILDERMAP; proves unnecessary,
we could/should get rid of this one, too,
by adding a parallel <literal>src_suffix</literal>
argument to the &Scanner; factory...
Comments?
-</REMARK>
+-->
<para>
@@ -1543,7 +1543,7 @@ Comments?
<section id="sect-custom">
<title>Customizing output</title>
-<REMARK>
+<!--
Take this whole section with a grain of salt.
I whipped it up without a great deal of thought
to try to add a "competitive advantage"
@@ -1554,7 +1554,7 @@ feels inflexible,
but I can't think of another way it would be
done effectively.
I dunno, maybe this is fine as it is...
-</REMARK>
+-->
<para>
@@ -1732,16 +1732,16 @@ I dunno, maybe this is fine as it is...
<section id="separate">
<title>Separate source and build trees</title>
-<REMARK>
+<!--
I've never liked Cons' use of the name <literal>Link</literal>
for this functionality,
mainly because the term is overloaded
with linking object files into an executable.
Yet I've never come up with anything better.
Any suggestions?
-</REMARK>
+-->
-<REMARK>
+<!--
Also, I made this an &Environment; method because
it logically belongs in the API reference
(the build engine needs to know about it),
@@ -1754,7 +1754,7 @@ associated with a specific environment
leaves it as a bare function call),
so maybe we should just follow that example
and not call it through an environment...
-</REMARK>
+-->
<para>
@@ -1833,14 +1833,14 @@ and not call it through an environment...
<section id="sect-repositories">
<title>Code repositories</title>
-<REMARK>
+<!--
Like &Link;, &Repository; and &Local; are part of the
API reference, but not really tied to any specific environment.
Is it better to be consistent about calling
everything in the API through an environment,
or to leave these independent so as
not to complicate their calling interface?
-</REMARK>
+-->
<para>
@@ -1900,10 +1900,10 @@ not to complicate their calling interface?
<section id="sect-caching">
<title>Derived-file caching</title>
-<REMARK>
+<!--
There should be extensions to this part of the API for
auxiliary functions like cleaning the cache.
-</REMARK>
+-->
<para>
@@ -1943,12 +1943,12 @@ auxiliary functions like cleaning the cache.
<section id="sect-jobs">
<title>Job management</title>
-<REMARK>
+<!--
This has been completely superseded by
the more sophisticated &Task; manager
that Anthony Roach has contributed.
I need to write that up...
-</REMARK>
+-->
<para>
diff --git a/doc/design/goals.sgml b/doc/design/goals.xml
index 774e04d..2a7b69b 100644
--- a/doc/design/goals.sgml
+++ b/doc/design/goals.xml
@@ -192,17 +192,25 @@
<section id="sect-fix-make">
<title>Fixing &Make;'s problems</title>
-<REMARK>
+ <para>
+
+<!--
To be written.
-</REMARK>
+-->
+
+ </para>
</section>
<section id="sect-fix-cons">
<title>Fixing &Cons;'s problems</title>
-<REMARK>
+ <para>
+
+<!--
To be written.
-</REMARK>
+-->
+
+ </para>
</section>
diff --git a/doc/design/install.sgml b/doc/design/install.xml
index 918fd64..e670e83 100644
--- a/doc/design/install.sgml
+++ b/doc/design/install.xml
@@ -23,6 +23,6 @@
-->
-<REMARK>
+<!--
THIS CHAPTER NEEDS TO BE DISCUSSED AND WRITTEN.
-</REMARK>
+-->
diff --git a/doc/design/intro.sgml b/doc/design/intro.xml
index 3ab8e3f..561baa4 100644
--- a/doc/design/intro.sgml
+++ b/doc/design/intro.xml
@@ -93,7 +93,7 @@
</para>
-<REMARK>
+<!--
Sections marked like this
(prefixed with <literal>RATIONALE:</literal> in the HTML,
surrounded by <literal>BEGIN RATIONALE:</literal>
@@ -106,6 +106,6 @@ I've used these to mark sections that need work,
but also to cite some open design issues.
If you have input on any of these marked issues,
I'm especially eager to hear it.
-</REMARK>
+-->
</section>
diff --git a/doc/design/issues.sgml b/doc/design/issues.xml
index 1f9a78c..1f9a78c 100644
--- a/doc/design/issues.sgml
+++ b/doc/design/issues.xml
diff --git a/doc/design/main.sgml b/doc/design/main.xml
index 6246a73..e991b36 100644
--- a/doc/design/main.sgml
+++ b/doc/design/main.xml
@@ -1,3 +1,5 @@
+<?xml version="1.0"?>
+
<!--
Copyright (c) 2001, 2002, 2003 Steven Knight
@@ -23,7 +25,8 @@
-->
-<!doctype book PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
[
<!--
@@ -31,7 +34,7 @@
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.sgml">
+ <!ENTITY % version SYSTEM "../version.xml">
%version;
-->
<!ENTITY builddate "2001/12/13 20:55:46">
@@ -46,16 +49,16 @@
<!ENTITY % scons SYSTEM "scons.mod">
%scons;
- <!ENTITY acks SYSTEM "acks.sgml">
- <!ENTITY bground SYSTEM "bground.sgml">
- <!ENTITY copyright SYSTEM "copyright.sgml">
- <!ENTITY engine SYSTEM "engine.sgml">
- <!ENTITY goals SYSTEM "goals.sgml">
- <!ENTITY install SYSTEM "install.sgml">
- <!ENTITY intro SYSTEM "intro.sgml">
- <!ENTITY issues SYSTEM "issues.sgml">
- <!ENTITY native SYSTEM "native.sgml">
- <!ENTITY overview SYSTEM "overview.sgml">
+ <!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">
]>
@@ -110,11 +113,15 @@
&native;
</chapter>
+ <!--
+
<chapter id="chap-install">
<title>Installation</title>
&install;
</chapter>
+ -->
+
<chapter id="chap-issues">
<title>Other Issues</title>
&issues;
diff --git a/doc/design/native.sgml b/doc/design/native.xml
index 5a791a7..8cdd867 100644
--- a/doc/design/native.sgml
+++ b/doc/design/native.xml
@@ -186,7 +186,7 @@
SConscript('src/SConscript', Export(env=env, debug=debug, installdir=installdir))
</programlisting>
-<REMARK>
+<!--
The <literal>env=env</literal> stuff bugs me
because it imposes extra work on the normal
case where you <emphasis>don't</emphasis> rename
@@ -198,7 +198,7 @@ is split into variables that are passed
through transparently?
Equivalent to the above example:
<literal>SConscript('src/SConscript', Export('env debug installdir'))</literal>
-</REMARK>
+-->
<para>
@@ -342,10 +342,10 @@ Equivalent to the above example:
</para>
-<REMARK>
+<!--
These need to be specified and explained
beyond what the man page will have.
-</REMARK>
+-->
<!-- BEGIN HTML -->
diff --git a/doc/design/overview.sgml b/doc/design/overview.xml
index 8d6f060..38e4258 100644
--- a/doc/design/overview.sgml
+++ b/doc/design/overview.xml
@@ -48,13 +48,13 @@
</para>
-<REMARK>
+<!--
Including this figure makes our PDF build blow up.
The figure, however,
is left over from the Software Carpentry contest
and is therefore old, out-of-date, and needs to be redone anyway.
This is where it will go, anyway...
-</REMARK>
+-->
<!--
YARG! THIS MAKES THE PDF BUILD BLOW UP. HELP!