[e-cvs] cvs commit: e/doc/elang/tools updoc.html
markm@eros.cs.jhu.edu
markm@eros.cs.jhu.edu
Sat, 15 Sep 2001 16:01:01 -0400
markm 01/09/15 16:01:01
Modified: doc toc.txt
doc/download index.html which.html
doc/download/0-8-10alpha index.html
doc/download/stl-0-8-9-t index.html
doc/download/stl-0-8-9-t-1 index.html
doc/elang/tools updoc.html
Log:
announcing the Dean-transformer release, 0.8.9t.1
Revision Changes Path
1.44 +5 -5 e/doc/toc.txt
Index: toc.txt
===================================================================
RCS file: /cvs/e/doc/toc.txt,v
retrieving revision 1.43
retrieving revision 1.44
diff -u -r1.43 -r1.44
--- toc.txt 2001/09/14 01:36:17 1.43
+++ toc.txt 2001/09/15 20:01:00 1.44
@@ -300,11 +300,11 @@
windows-src.html
unix-bin.html
unix-src.html
- 0-8-10alpha/
- windows-bin.html
- windows-src.html
- unix-bin.html
- unix-src.html
+# 0-8-10alpha/
+# windows-bin.html
+# windows-src.html
+# unix-bin.html
+# unix-src.html
donate.html
# nopayment.html
# payment.html
1.27 +8 -4 e/doc/download/index.html
Index: index.html
===================================================================
RCS file: /cvs/e/doc/download/index.html,v
retrieving revision 1.26
retrieving revision 1.27
diff -u -r1.26 -r1.27
--- index.html 2001/09/14 01:36:17 1.26
+++ index.html 2001/09/15 20:01:00 1.27
@@ -81,16 +81,20 @@
</tr>
<tr>
<td> </td>
- <td><a href="stl-0-8-9-t/index.html">stl-0.8.9t</a>: Non distributed
+ <td><a href="stl-0-8-9-t/index.html"><b>stl-0.8.9t</b></a>: Non distributed
internal release. Major syntax reform. Enhanced eBrowser.</td>
</tr>
<tr>
<td> </td>
- <td><a href="stl-0-8-9-t-1/index.html"><b>stl-0.8.9t.1</b></a>: Dean's
- transformer -- more efficient interpretation, and a first step towards
- an <i><b><font color="#009000">E</font></b></i> compiler.</td>
+ <td><a href="stl-0-8-9-t-1/index.html">stl-0.8.9t.1</a>: Dean's transformer
+ -- more efficient interpretation, and a first step towards an <i><b><font color="#009000">E</font></b></i>
+ compiler.</td>
</tr>
</table>
+ <p><b><i>Note: We are imminently about to release 0.8.10alpha1, which, though
+ still in a preliminary state, is probably better than any of the above
+ choices for use </i></b><i>(as opposed to internal development work on
+ the compiler, for which 0.8.9t.1 is better).</i> </p>
<!-- #EndEditable --></TD>
<TD WIDTH="10%"> </TD>
</TR>
1.30 +20 -14 e/doc/download/which.html
Index: which.html
===================================================================
RCS file: /cvs/e/doc/download/which.html,v
retrieving revision 1.29
retrieving revision 1.30
diff -u -r1.29 -r1.30
--- which.html 2001/09/14 01:36:17 1.29
+++ which.html 2001/09/15 20:01:00 1.30
@@ -49,7 +49,7 @@
<hr>
<!-- #BeginEditable "LongBody" -->
<p>The current release of <b><i><font color="#009000">E</font></i></b> is
- <a href="0-8-9/index.html"><b>0.8.9</b></a>. However, this is an interim
+ <a href="0-8-9-1/index.html"><b>0.8.9.1</b></a>. However, this is an interim
release that is known to have a crippling bug for certain uses. Therefore,
you may instead want the stable <a href="0-8-4/index.html"><b>0.8.4</b></a>
release, which does not exhibit this bug. The bug is that some distributed
@@ -58,7 +58,9 @@
messaging. The slowdown is dramatic enough to render a normally speedy
distributed application unusable. This bug will be fixed in the <b><i><font color="#009000">E</font></i></b>
0.8.10 release, at which time we will retire both <b><i><font color="#009000">E</font></i></b>
- 0.8.4 and <b><i><font color="#009000">E</font></i></b> 0.8.9.</p>
+ 0.8.4 and <b><i><font color="#009000">E</font></i></b> 0.8.9.1. <b><i>Note:
+ We are imminently about to release 0.8.10alpha1, which, though still in
+ a preliminary state, is probably better than either of the above choices.</i></b></p>
<p>Unfortunately, there has been a non-upwards-compatible syntactic change
between <b><i><font color="#009000">E</font></i></b> 0.8.4 and the current
<b><i><font color="#009000">E</font></i></b> 0.8.9.</p>
@@ -115,22 +117,26 @@
are now non-mutable by default.</p>
</li>
<li>
- <p><a href="stl-0-8-9-t/index.html">E stl-0.8.9t</a> is an interim non-distributed
- version, released with some major syntactic reforms due to discussion
- on the e-lang list. Also, it has a much improved eBrowser. </p>
- </li>
- <li><a href="stl-0-8-9-t-1/index.html"><b>E stl-0.8.9t.1</b></a> is an
- internal branch off of stl-0.8.9t, released mainly to support E compilation
- work, in which the old slow interpreter has been replaced by Dean's
- new transformer and faster interpreter. Besides speeding interpretation,
- this transformation should be major progress towards an E compiler.</li>
+ <p><a href="stl-0-8-9-t/index.html"><b>E stl-0.8.9t</b></a> is an interim
+ non-distributed version, released with some major syntactic reforms
+ due to discussion on the e-lang list. Also, it has a much improved
+ eBrowser. </p>
+ </li>
+ <li><a href="stl-0-8-9-t-1/index.html">E stl-0.8.9t.1</a> is an internal
+ branch off of stl-0.8.9t, released mainly to support E compilation work,
+ in which the old slow interpreter has been replaced by Dean's new transformer
+ and faster interpreter. Besides speeding interpretation, this transformation
+ should be major progress towards an E compiler.</li>
</ul>
<p>So the price of developing with <b><i><font color="#009000">E</font></i></b>
0.8.9.1 is that, once <b><i><font color="#009000">E</font></i></b> 0.8.10
is released, you will have to edit your program to use the new syntax.
- If your current use of <b><i><font color="#009000">E</font></i></b> does
- not yet involve distributed (inter-Vat) messaging, then you should use
- the <b><i></i></b>stl-0.8.9t.1 release.</p>
+ If you don't immediately need to do distributed programming, we suggest
+ one of the 0.8.9t releases, in order to use the modern version of the
+ language. <b><i>Note: We are imminently about to release 0.8.10alpha1,
+ which, though still in a preliminary state, is probably better than any
+ of the above choices for use </i></b><i>(as opposed to internal development
+ work on the compiler, for which 0.8.9t.1 is better).</i> </p>
<!-- #EndEditable --></TD>
<TD WIDTH="10%"> </TD>
</TR>
1.3 +1 -1 e/doc/download/0-8-10alpha/index.html
Index: index.html
===================================================================
RCS file: /cvs/e/doc/download/0-8-10alpha/index.html,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- index.html 2001/09/15 03:16:00 1.2
+++ index.html 2001/09/15 20:01:00 1.3
@@ -33,7 +33,7 @@
<!-- #BeginEditable "Path" -->/ <a href="../index.html">download</a> <!-- #EndEditable --></td>
</tr>
<tr>
- <td valign="top" align="right"><!-- #BeginEditable "PrevButton" --><a href="../stl-0-8-9-t-1/index.html"><img src="../../images/prev.gif" width="64" height="32" alt="Back to: E stl-0.8.9t.1 Download and Install E" border="0"></a><!-- #EndEditable --></td>
+ <td valign="top" align="right"><!-- #BeginEditable "PrevButton" --><a href="../stl-0-8-9-t-1/index.html"><img src="../../images/prev.gif" width="64" height="32" alt="Back to: E stl-0.8.9t.1a Download and Install E" border="0"></a><!-- #EndEditable --></td>
<td valign="bottom" align="left"><!-- #BeginEditable "FirstButton" --><a href="windows-bin.html"><img src="../../images/first.gif" width="32" height="64" alt="1st child: E 0.8.10alpha1: Installing on Windows" border="0"></a><!-- #EndEditable --></td>
<td valign="top" align="left"><!-- #BeginEditable "NextButton" --><img src="../../images/next-gray.gif" width="64" height="32"><!-- #EndEditable --></td>
</tr>
1.4 +1 -1 e/doc/download/stl-0-8-9-t/index.html
Index: index.html
===================================================================
RCS file: /cvs/e/doc/download/stl-0-8-9-t/index.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.html 2001/09/14 01:36:17 1.3
+++ index.html 2001/09/15 20:01:00 1.4
@@ -35,7 +35,7 @@
<tr>
<td valign="top" align="right"><!-- #BeginEditable "PrevButton" --><a href="../0-8-9-1/index.html"><img src="../../images/prev.gif" width="64" height="32" alt="Back to: E 0.8.9.1 Download and Install E" border="0"></a><!-- #EndEditable --></td>
<td valign="bottom" align="left"><!-- #BeginEditable "FirstButton" --><a href="windows-bin.html"><img src="../../images/first.gif" width="32" height="64" alt="1st child: E stl-0.8.9t: Installing on Windows" border="0"></a><!-- #EndEditable --></td>
- <td valign="top" align="left"><!-- #BeginEditable "NextButton" --><a href="../stl-0-8-9-t-1/index.html"><img src="../../images/next.gif" width="64" height="32" alt="On to: E stl-0.8.9t.1 Download and Install E" border="0"></a><!-- #EndEditable --></td>
+ <td valign="top" align="left"><!-- #BeginEditable "NextButton" --><a href="../stl-0-8-9-t-1/index.html"><img src="../../images/next.gif" width="64" height="32" alt="On to: E stl-0.8.9t.1a Download and Install E" border="0"></a><!-- #EndEditable --></td>
</tr>
</table>
</TD>
1.4 +61 -18 e/doc/download/stl-0-8-9-t-1/index.html
Index: index.html
===================================================================
RCS file: /cvs/e/doc/download/stl-0-8-9-t-1/index.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- index.html 2001/09/15 06:02:45 1.3
+++ index.html 2001/09/15 20:01:01 1.4
@@ -35,7 +35,7 @@
<tr>
<td valign="top" align="right"><!-- #BeginEditable "PrevButton" --><a href="../stl-0-8-9-t/index.html"><img src="../../images/prev.gif" width="64" height="32" alt="Back to: E stl-0.8.9t Download and Install E" border="0"></a><!-- #EndEditable --></td>
<td valign="bottom" align="left"><!-- #BeginEditable "FirstButton" --><a href="windows-bin.html"><img src="../../images/first.gif" width="32" height="64" alt="1st child: E stl-0.8.9t.1a: Installing on Windows" border="0"></a><!-- #EndEditable --></td>
- <td valign="top" align="left"><!-- #BeginEditable "NextButton" --><a href="../0-8-10alpha/index.html"><img src="../../images/next.gif" width="64" height="32" alt="On to: E 0.8.10alpha1 Download and Install E" border="0"></a><!-- #EndEditable --></td>
+ <td valign="top" align="left"><!-- #BeginEditable "NextButton" --><img src="../../images/next-gray.gif" width="64" height="32"><!-- #EndEditable --></td>
</tr>
</table>
</TD>
@@ -133,16 +133,61 @@
<p> </p>
<hr>
<h1><a name="Highlights"></a>Highlights of this Version</h1>
- <p><i><font color="#009000"><b>E</b></font></i><b> stl-0.8.9t.1a</b> is a
- branch off of 0.8.9t, contributed by Dean Tribble, in which the inefficient
- E interpreter -- which would evaluate variables by looking up names in
- a chain of hashtables -- has now been replaced by one which first does
- scope analysis and transforms the tree into one which accesses variables
- by indexing into an array. For low-latency evaluation, such as at a command
- line, this is just right. </p>
- <p>For separate compilation, we still seek to compile E to a more efficient
- form (like JVM bytecodes or something suitable for ENative). We hope and
- expect that this transformation is also a major step towards a real compiler.</p>
+ <p><i><font color="#009000"><b>E</b></font></i><b> stl-0.8.9t.1a</b> is
+ a branch off of 0.8.9t, contributed by Dean Tribble, who says:</p>
+ <p>This is an initial development release for a faster E interpreter. This
+ release is intended for joint implementation, so the minimal documentation
+ in the release is not yet intended for users This interpreter is intended
+ to both provide faster interactive E execution, and provide initial steps
+ towards full compilation. When complete and integrated with the main line
+ of E development, it is expected to replace the current E interpreter.</p>
+ <p>The primary change in this interpreter is to use an addressing-oriented
+ execution model. Specifics include:</p>
+ <ul>
+ <li>
+ <p>Outers, fields, and locals are stored and accessed from Arrays rather
+ than through Hash tables (i.e., noun get and store are via a single
+ array indirection)</p>
+ </li>
+ <li>
+ <p>Final nouns (which is expected to be most nouns) point directly at
+ their value, not indirectly through Slots</p>
+ </li>
+ <li>
+ <p>The execution state at any given point is always represented as three
+ arrays: outers, fields, and locals</p>
+ </li>
+ <li>
+ <p>Locals are used in a stack-like fashion</p>
+ </li>
+ <li>
+ <p>Each expr node points at its scope map, so the values in scope can
+ be reconstructed in a future debugger</p>
+ </li>
+ <li>
+ <p>All non-finals use slot objects so that they can be copied into nested
+ objects but still behave as shared mutable variables (i.e., as in
+ the cells used in Scheme compilation)</p>
+ </li>
+ <li>
+ <p>Numerous minor optimizations</p>
+ </li>
+ <li>
+ <p>All ENodes point at immutable ScopeMaps that describe which variables
+ are visible and where to find them in the EvalContext (for future
+ debugging support)</p>
+ </li>
+ <li>
+ <p>Clarified semantics of mutable, interactive scopes, import, and other
+ scoping-related issues.</p>
+ </li>
+ </ul>
+ <p>This is still a work in progress. The parser in this version does not
+ yet actually generate FinalPattern nodes, so the change in representation
+ of Finals is not yet used (and indeed, depends on bug fixes not yet integrated
+ from the main development line). Additional complimentary optimizations
+ will be included in future releases that eliminate method dispatch overhead,
+ comparison overhead, etc.</p>
<hr>
<h1><a name="variants"></a>Variants and Subsets of E</h1>
<p>A complete <font color="#009000"><em><b>E</b></em></font> system is persistent,
@@ -259,10 +304,8 @@
inconsistency</a>: The Java/JVM 2.x standard corresponds to Sun's jdk/jre
1.2.x. We ignore this inconsistency and refer to both as 1.2.x.</p>
<p>This version of <font color="#009000"><em><b>E</b></em></font> requires
- a jre >= 1.2.x. E no longer supports Java < 1.2. To build <font color="#009000"><em><b>E</b></em></font>
- from sources, a corresponding jdk is required. We recommend a JDK >=
- 1.3.x. In particular, we recommend against 1.2.2. (Sun's Swing implementation
- in 1.2.2 does not, ahem, live up to Sun's usual quality standards.) </p>
+ a jre >= 1.3.1. E no longer supports Java < 1.3.1. To build <font color="#009000"><em><b>E</b></em></font>
+ from sources, a corresponding jdk is required. </p>
<p>Some places to get a jre or jdk:</p>
<div align="center">
<table cellpadding="12" border="2">
@@ -347,9 +390,9 @@
<p><i>Note: The website at the above link, http://www.lincom-asg.com/~rjamison/byacc/,
seems to have disappeared. If you know where it may have gone to, or know
how to contact Bob Jamison, please let <a href="mailto:webmaster@erights.org">me</a>
- know. In the meantime, starting with the 0.8.9t.1a release, the sources to
- byaccj are bundled with the E sources, and byaccj is made as part of making
- E. </i></p>
+ know. In the meantime, starting with the 0.8.9t.1a release, the sources
+ to byaccj are bundled with the E sources, and byaccj is made as part of
+ making E. </i></p>
<h3>Zip Files</h3>
<p>Our build process packs up the <code>*.zip</code> files in the distribution
by using <a href="ftp://ftp.freesoftware.com/pub/infozip/">Info-Zip</a>'s
1.9 +54 -44 e/doc/elang/tools/updoc.html
Index: updoc.html
===================================================================
RCS file: /cvs/e/doc/elang/tools/updoc.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -u -r1.8 -r1.9
--- updoc.html 2001/09/14 01:36:17 1.8
+++ updoc.html 2001/09/15 20:01:01 1.9
@@ -77,8 +77,8 @@
blank line. This is followed by the name of the file that was processed.
Test cases that pass are shown as dots ('.'). (This is a simple visual
indication that Updoc is still cranking away. When the input is very large
- and most tests succeed, the dots can be very reassuring.) The report for
- failing test cases includes the expression that failed and failure details.</p>
+ and most tests succeed, the dots can be reassuring.) The report for failing
+ test cases includes the expression that failed and failure details.</p>
<p>If you copy the contents of this chapter into a plain text file, let's
say, "<code>updoc.txt</code>", you can interactively read it
in <i>Elmer</i>. Elmer allows you to try out these examples -- or variants
@@ -306,19 +306,10 @@
provided by these programs. This means that the decision to run an Updoc
script must be taken exactly as seriously as the decision of run a <code>*.e</code>
script, which is to say, as seriously as the decision to install a conventional
- program on your computer.</p>
+ program on your computer. <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125387&group_id=16380">Track
+ this issue...</a> )</i></p>
<h1><a name="future"></a>Future Directions</h1>
<h2><a name="bugs"></a>Bugs & Other Correctness Issues</h2>
- <p><b><i><a name="security-bug"></a>Security</i></b>. Regarding the above
- security issue, the E system supports less privileged code contexts --
- emakers and caplets. (EMakers are already supported. Caplets are coming
- soon.) EMakers are evaluated with no authority to affect the world outside
- themselves. Caplets are emakers whose evaluation result is, by convention,
- handed certain restricted authorities -- primarily the authority to ask
- (presumably the user) for more authority. We anticipate a future means
- of running Updoc scripts in a caplet-like way: of implicitly turning its
- usage of names from the privileged scope (like <code><unsafe:...></code>
- above) into authorization requests. In the meantime, watch out.</p>
<p><a name="platform-depend-bug"></a><i><b>Platform dependence</b></i>.
While Updoc itself is as platform independent as E (which, in turn, inherits
Java's platform independence), Updoc scripts may be as platform dependent
@@ -331,7 +322,8 @@
addressing the above security issue, since the solutions will share much
mechanism. Until this issue is fixed, the existing Updoc test scripts
in the E source tree and on the erights.org website make no claims of
- platform independence.</p>
+ platform independence. <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125388&group_id=16380">Track
+ this issue...</a> )</i></p>
<p><a name="modularity-bug"></a>Internal <b><i>modularity</i></b>. As with
many E programs, Updoc was prototyped as one long <code>*.e</code> file
("<code>updoc.e</code>"). Following this prototyping phase,
@@ -343,32 +335,41 @@
file, without needing to read the <code>*.emaker</code> files. <font color="#ff0000">(**Move
this explanation somewhere else and link to it.)</font> Updoc has not
yet entered this post-prototyping phase -- it has not yet been separated
- into <code>*.emaker</code> files. </p>
+ into <code>*.emaker</code> files. <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125389&group_id=16380">Track
+ this issue...</a> )</i></p>
<p><a name="cmd-line-bug"></a>We need to implement the <i><b>command line
- options</b></i> explained <a href="#command-line">above</a>.</p>
- <p><a name="interp-bug"></a>Which <b><i>interpreter</i></b>?. Currently,
- each test script is evaluated in an environment (scope) in which "<code>interp</code>",
- "<code>stdout</code>", and "<code>stderr</code>" are
- bound to the same values as for Updoc itself. Instead, each test script
- should be given a new interpreter, new output streams, and a new instance
- of the trace system. The output sent to the streams and to this trace
- instance by each test case should be treated as additional answers produced
- by that test case, to be compared along with the others.</p>
- <p><i><b><a name="delay-bug"></a>Delaying test cases</b></i>. The "<code>interp</code>"
- object seen by an Updoc test case does not yet support the messages "<code>blockAtTop()</code>"
+ options</b></i> explained <a href="#command-line">above</a>. <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125390&group_id=16380">Track
+ this issue...</a> )</i></p>
+ <p><font color="#009900"><a name="interp-bug"></a>Which <b><i>interpreter</i></b>?.
+ Currently, each test script is evaluated in an environment (scope) in
+ which "<code>interp</code>", "<code>stdout</code>",
+ and "<code>stderr</code>" are bound to the same values as for
+ Updoc itself. Instead, each test script should be given a new interpreter,
+ new output streams, and a new instance of the trace system. The output
+ sent to the streams and to this trace instance by each test case should
+ be treated as additional answers produced by that test case, to be compared
+ along with the others. <i>( Fixed. <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125391&group_id=16380">Track
+ this issue...</a> )</i></font></p>
+ <p><font color="#009900"><i><b><a name="delay-bug"></a>Delaying test cases</b></i>.
+ The "<code>interp</code>" object seen by an Updoc test case
+ does not yet support the messages "<code>blockAtTop()</code>"
and "<code>continueAtTop()</code>". These are currently supported
by the E interpreter, but need to be supported by Updoc as well, so that
a test script can pause between a test case that is supposed to cause
some effect to eventually happen and a test case written assuming the
- effect has happened (such as a promise being resolved).</p>
- <p><i><b><a name="nest-exit-bug"></a>Nesting exiting</b></i>. The "<code>interp</code>"
- object seen by an Updoc test case also needs to support the message "<code>exitAtTop(exitCode)</code>",
+ effect has happened (such as a promise being resolved). <i>( Fixed. <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125392&group_id=16380">Track
+ this issue...</a> )</i></font></p>
+ <p><font color="#009900"><i><b></b></i></font><i><b><a name="nest-exit-bug"></a>Nesting
+ exiting</b></i>. The "<code>interp</code>" object seen by an
+ Updoc test case also needs to support the message "<code>exitAtTop(exitCode)</code>",
as does the normal E interpreter. E programs should call this, rather
than "<code>System exit(exitCode)</code>", in order to terminate
early. By using "<code>interp exitAtTop(exitCode)</code>",
an E program being run by another E program (as with an Updoc test script)
may exit its nested interpreter without causing the JVM to exit. <font color="#ff0000">(**
- Put this issue into documentation of the normal E interpreter.)</font></p>
+ Put this issue into documentation of the normal E interpreter.)</font>
+ <i>( Mostly fixed. <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125393&group_id=16380">Track
+ this issue...</a> )</i></p>
<p><i><b><a name="exitcode-bug"></a>Updoc's own exitCode</b></i>. Updoc
should remember whether any problems were encountered during an Updoc
run, or if instead all the test cases passed. Only if all the cases passed
@@ -376,17 +377,22 @@
a non-zero exitCode, indicating a problem. This would allow shell scripts
and makefiles to test or stop on a test failure. (Currently, Updoc always
returns an exitCode of 0.) Of course, once the E interpreter supports
- <code>exitAtTop(exitCode)</code>, Updoc should use it for this purpose.</p>
- <p><a name="syntax-error-bug"></a>An Updoc <b><i>syntax error</i></b> report
- doesn't yet conform to Updoc's output format. In addition, because of
- the order in which Updoc processes a test script, if a script contains
- a syntax error, no feedback from earlier test cases in that script will
- be seen.</p>
- <p><i><b><a name="continuation-bug"></a>Line continuation</b></i>. Updoc
- should understand "\" at the end of a line in the original answer
- to mean, ignore the following newline. This would let answers in documentation
- (such as the ClassCastException in "<a href="../blocks/defVar.html">Defining
- Variables</a>") to be broken into shorter lines for readability.</p>
+ <code>exitAtTop(exitCode)</code>, Updoc should use it for this purpose.
+ <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125394&group_id=16380">Track
+ this issue...</a> )</i></p>
+ <p><font color="#009900"><a name="syntax-error-bug"></a>An Updoc <b><i>syntax
+ error</i></b> report doesn't yet conform to Updoc's output format. In
+ addition, because of the order in which Updoc processes a test script,
+ if a script contains a syntax error, no feedback from earlier test cases
+ in that script will be seen. <i>( Fixed. <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125395&group_id=16380">Track
+ this issue...</a> )</i></font></p>
+ <p><font color="#009900"><i><b><a name="continuation-bug"></a>Line continuation</b></i>.
+ Updoc should understand "\" at the end of a line in the original
+ answer to mean, ignore the following newline. This would let answers in
+ documentation (such as the ClassCastException in "<a href="../blocks/defVar.html">Defining
+ Variables</a>") to be broken into shorter lines for readability.
+ <i>( Fixed. <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125396&group_id=16380">Track
+ this issue...</a> )</i></font></p>
<h2><a name="features"></a>Coming Attractions</h2>
<p><a name="matching-feature"></a><i><b>Pattern matching</b></i>. Sometimes
the output from one run to the next differs in inconsequential ways. Sometimes
@@ -399,12 +405,15 @@
the test case which defines the variable "<code>capitals</code>"
shows an answer with keyword "<code>match:</code>". This should
match against an actual "<code>value:</code>" answer by treating
- the "<code>...</code>" in the match-answer as a wildcard.</p>
+ the "<code>...</code>" in the match-answer as a wildcard. <i>(
+ <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125397&group_id=16380">Track
+ this issue...</a> )</i></p>
<p><i><b><a name="elmer-feature"></a>Elmer integration</b></i>. For each
test case that fails you probably want to find the file it's in, find
the expression that failed, and fix the problem. Interactively locating
and fixing problems in scripts will be supported when Updoc's functionality
- is integrated into Elmer.</p>
+ is integrated into Elmer. <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125398&group_id=16380">Track
+ this issue...</a> )</i></p>
<p><i><b><a name="coverage-feature"></a>Interface coverage</b></i>. An individual
Updoc file will often be an explanation of the API for a given abstraction,
or a closely related set of abstractions. Chapters in programming manuals
@@ -426,7 +435,8 @@
and wasn't exercised during the running of this test script. This both
tells the user what's been demonstrated and left out by this chapter,
and, because this coverage report would be shown as an Updoc answer, it
- is automatically rechecked for accuracy.</p>
+ is automatically rechecked for accuracy. <i>( <a href="https://bugs.sieve.net/bugs/?func=detailbug&bug_id=125399&group_id=16380">Track
+ this issue...</a> )</i></p>
<!-- #EndEditable --></TD>
<TD WIDTH="10%"> </TD>
</TR>