generate_test_rb.html in ruby-vpi-9.0.0

- old
+ new

@@ -54,11 +54,11 @@
       <td>bin/generate_test.rb
       </td>
     </tr>
     <tr class="top-aligned-row">
       <td><strong>Last Update:</strong></td>
-      <td>Fri Oct 13 08:52:41 PDT 2006</td>
+      <td>Sat Oct 28 02:20:39 PDT 2006</td>
     </tr>
     </table>
   </div>
   <!-- banner header -->
 
@@ -71,32 +71,54 @@
     <div id="description">
       <p>
 Generates Ruby-VPI tests from Verilog 2001 module declarations.
 </p>
 <ul>
-<li>If no input files are specified, then the standard input stream is assumed
-to be the input.
+<li>The standard input stream is read if no input files are specified.
 
 </li>
 <li>The first input signal in a module&#8217;s declaration is assumed to be the
 clocking signal.
 
 </li>
-<li>Existing output files will be backed-up before being over-written. A
-backed-up file has a tilde (~) appended to its name.
-
-</li>
 </ul>
+<h1>Progress indicators</h1>
+<p>
+As this tool performs its duties, it notifies you of important information
+using the following indicators.
+</p>
+<table>
+<tr><td valign="top">create:</td><td>Output file does not exist. It will be created.
 
+</td></tr>
+<tr><td valign="top">skip:</td><td>Output file exists and is up to date.
+
+</td></tr>
+<tr><td valign="top">update:</td><td>Output file exists and is out of date. A backup copy will be made (with a
+&quot;.old&quot; suffix) before this output file is updated. Use a text
+merging tool or manually transfer any necessary information from the backup
+copy to the updated output file.
+
+</td></tr>
+</table>
+<h1>Environment variables</h1>
+<table>
+<tr><td valign="top">MERGER:</td><td>A command for invoking a text merging tool with two arguments: old file,
+new file. The tool should save its output to the new file.
+
+</td></tr>
+</table>
+
     </div>
 
     <div id="requires-list">
       <h3 class="section-bar">Required files</h3>
 
       <div class="name-list">
       ruby-vpi/verilog_parser&nbsp;&nbsp;
       fileutils&nbsp;&nbsp;
+      digest/md5&nbsp;&nbsp;
       ruby-vpi/erb&nbsp;&nbsp;
       optparse&nbsp;&nbsp;
       ruby-vpi/rdoc&nbsp;&nbsp;
       </div>
     </div>
@@ -105,11 +127,12 @@
 
     <div id="method-list">
       <h3 class="section-bar">Methods</h3>
 
       <div class="name-list">
-      <a href="#M000001">write_file</a>&nbsp;&nbsp;
+      <a href="#M000001">notify</a>&nbsp;&nbsp;
+      <a href="#M000002">write_file</a>&nbsp;&nbsp;
       </div>
     </div>
 
   </div>
 
@@ -176,17 +199,34 @@
         <a name="M000001"></a>
 
         <div class="method-heading">
           <a href="generate_test_rb.src/M000001.html" target="Code" class="method-signature"
             onclick="popupCode('generate_test_rb.src/M000001.html');return false;">
+          <span class="method-name">notify</span><span class="method-args">(*args)</span>
+          </a>
+        </div>
+      
+        <div class="method-description">
+          <p>
+Notify the user about some action being performed.
+</p>
+        </div>
+      </div>
+
+      <div id="method-M000002" class="method-detail">
+        <a name="M000002"></a>
+
+        <div class="method-heading">
+          <a href="generate_test_rb.src/M000002.html" target="Code" class="method-signature"
+            onclick="popupCode('generate_test_rb.src/M000002.html');return false;">
           <span class="method-name">write_file</span><span class="method-args">(aPath, aContent)</span>
           </a>
         </div>
       
         <div class="method-description">
           <p>
 Writes the given contents to the file at the given path. If the given path
-already exists, then a backup is created before proceeding.
+already exists, then a backup is created before invoking the merging tool.
 </p>
         </div>
       </div>
 
 
\ No newline at end of file