diff options
Diffstat (limited to 'doc/design')
-rw-r--r-- | doc/design/MANIFEST | 22 | ||||
-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! |