ruby-vpi 9.0.0 → 10.0.0

data/history.html

@@ -113,6 +113,86 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p id="fn1"><sup>1</sup> C. Gross, &#8220;Explaining Open Source Version Numbers&#8221;, [Online document], 2005 Nov 28, [cited 2006 Aug 27], Available <span class="caps">HTTP</span>: <a href="http://ablog.apress.com/?p=738">http://ablog.apress.com/?p=738</a></p>
 
 
+	<h1>Version 10.0.0 (2006-11-05)</h1>
+
+
+	<h2>Summary</h2>
+
+
+	<p>This release adds the ability to access a handle&#8217;s children and reduces the amount of code produced by the automated test generator.</p>
+
+
+	<h2>Acknowledgment</h2>
+
+
+	<p>Thanks to Matt Fischler for finding the problem of misdirected compilation errors in Verilog benches.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The way in which Ruby-VPI and generated tests interact has changed: the design is now a <span class="caps">VPI</span> handle object and the <code>design.rb</code> and <code>proto.rb</code> files define <a href="http://wiki.rubygarden.org/Ruby/page/show/SingletonTutorial">singleton methods</a> for that object.
+	<ul>
+	<li>I suggest that you regenerate your existing tests (just run <strong>generate_test.rb</strong> again) whilst employing the service of a text merging tool (see the user manual).</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>You can now access a handle&#8217;s children by simply calling methods on it. In the event that a child handle has the same name as a <span class="caps">VPI</span> property, the child is given priority. However, you can always access <span class="caps">VPI</span> properties explicitly via the <code>get_value</code> and <code>put_value</code> methods.</li>
+	</ul>
+
+
+	<ul>
+	<li><strong>generate_test.rb</strong> no longer accepts the <code>-s</code> and <code>-u</code> options. Use their longer counterparts <code>--rspec</code> and <code>--xunit</code> instead.</li>
+	</ul>
+
+
+	<h2>Detail</h2>
+
+
+	<h3>Automated test generator</h3>
+
+
+	<ul>
+	<li>Generated Verilog benches no longer divert compilation errors from Verilog design files. That is, if the Verilog simulator finds compilation errors in a Verilog design file, it will report that the Verilog design file is at fault (instead of reporting that the generated Verilog bench is at fault).</li>
+	</ul>
+
+
+	<ul>
+	<li>The user is now notified when a backup of an existing file is made.</li>
+	</ul>
+
+
+	<ul>
+	<li>Generated tests have been greatly simplified to reduce the amount of work for the user.
+	<ul>
+	<li>The design is now just a handle to the module in the Verilog bench.</li>
+		<li><code>include Vpi</code> and <code>@design</code> are no longer generated.</li>
+		<li>The tutorial and examples have been updated accordingly.</li>
+	</ul></li>
+	</ul>
+
+
+	<h3>User manual</h3>
+
+
+	<ul>
+	<li>Revised the stylesheet to make disjoint sections readily distinguishable from eachother, through generous spacing and minor coloring.</li>
+	</ul>
+
+
+	<ul>
+	<li>Added tips about <code>ruby-vpi/runner_proxy</code>, <code>rake -T</code>, and using <strong>kdiff3</strong> with <strong>generate_test.rb</strong>.</li>
+	</ul>
+
+
+	<ul>
+	<li>Moved installation information into a new &#8220;setup&#8221; chapter.</li>
+	</ul>
+
+
 	<h1>Version 9.0.0 (2006-10-28)</h1>
 
 
@@ -122,7 +202,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release improves the automated test generator and adds new content to the user manual.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<p>Thanks to Matt Fischler for helping test and debug the installation of Ruby-VPI on Windows.</p>
@@ -136,7 +216,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -188,7 +268,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release simplifies configuration of generated tests.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<p>Thanks to <a href="http://www.soe.ucsc.edu/classes/cmpe126/Fall06/">students in <span class="caps">CMPE</span>-126</a> for their constructive criticism.</p>
@@ -202,7 +282,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -229,7 +309,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -262,7 +342,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -308,13 +388,13 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<ul>
 	<li>Handles now have two new methods:
 	<ul>
-	<li><code>handle.x?</code>&#8212;checks if the logic value is &#8220;don&#8217;t care&#8221; </li>
-		<li><code>handle.z?</code>&#8212;checks if the logic value is high impedance</li>
+	<li><code>handle.x?</code> checks if the logic value is &#8220;don&#8217;t care&#8221; </li>
+		<li><code>handle.z?</code> checks if the logic value is high impedance</li>
 	</ul></li>
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -344,13 +424,13 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds initial<sup><a href="#fn1">1</a></sup> support for code coverage analysis via the <a href="http://eigenclass.org/hiki.rb?rcov">rcov library</a>.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<p>Thanks to Mauricio Fernandez for helping me use rcov without its runner.</p>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -378,7 +458,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release simplifies running of multiple tests, restores compatibility with Synopsys <span class="caps">VCS</span>, and better integrates with RubyGems.</p>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -415,7 +495,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release distributes Ruby-VPI as a gem, improves portability of generated tests, and fixes a bug.</p>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
 
 
 	<ul>
@@ -423,11 +503,6 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<ul>
-	<li>Ruby-VPI is now distributed only as a <a href="http://www.rubygems.org">source gem</a>. You can decompress the gem without installing it onto your system by running the command <code>gem install -i output_directory ruby-vpi-7.0.0.gem</code>. In addition, you can still obtain the source code directly from the Subversion repository.</li>
-	</ul>
-
-
 	<ul>
 	<li>The test generator&#8217;s templates and the examples have been updated as follows:
 	<ul>
@@ -447,6 +522,14 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
+	<h2>Detail</h2>
+
+
+	<ul>
+	<li>Ruby-VPI is now distributed only as a <a href="http://www.rubygems.org">source gem</a>. You can decompress the gem without installing it onto your system by running the command <code>gem install -i output_directory ruby-vpi-7.0.0.gem</code>. In addition, you can still obtain the source code directly from the Subversion repository.</li>
+	</ul>
+
+
 	<ul>
 	<li>The tools in <code>bin/</code> become available in your system&#8217;s <code>bin/</code> directory when the gem is installed.
 	<ul>
@@ -479,20 +562,27 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds support for the <span class="caps">GPL</span> Cver simulator, provides both binary and source packages, and explicitly defines the version numbering system.</p>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
 
 
 	<ul>
-	<li>The <span class="caps">GPL</span> Cver simulator is now supported.</li>
+	<li>Ruby-VPI now only needs to be built once.
+	<ul>
+	<li>You can run tests with different Verilog simulators without having to re-compile Ruby-VPI.</li>
+	</ul></li>
 	</ul>
 
 
+	<h2>Detail</h2>
+
+
 	<ul>
-	<li>Ruby-VPI now only needs to be built once.
+	<li>The <span class="caps">GPL</span> Cver simulator is now supported.</li>
+	</ul>
+
+
 	<ul>
-	<li>You can run tests with different Verilog simulators without having to re-compile Ruby-VPI.</li>
-		<li>Release packages are now available in both source and binary form.</li>
-	</ul></li>
+	<li>Release packages are now available in both source and binary form.</li>
 	</ul>
 
 
@@ -587,31 +677,34 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release beautifies generated tests, adds checks to find signal width bugs, and includes a new tool.</p>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
 
 
 	<ul>
-	<li>The test generator now uses <span class="caps">ERB</span> templates which ensures nice indentation of generated output.</li>
+	<li><code>put_value()</code> now returns the value it puts. Therefore, it is easier to chain together a series of assignments: <code>foo.intVal = bar.intVal = baz.intVal = 10</code></li>
 	</ul>
 
 
 	<ul>
-	<li>The test generator now decouples Ruby-VPI paths from Verilog benches via the <span class="caps">RUBYLIB</span> environment variable.</li>
+	<li><code>put_value()</code> now verifies that the value it puts was written correctly. This helps to find bugs regarding invalid assumptions about the number of bits supported by a signal.</li>
 	</ul>
 
 
+	<h2>Detail</h2>
+
+
 	<ul>
-	<li>A tool which converts Verilog headers into Ruby has been added.</li>
+	<li>The test generator now uses <span class="caps">ERB</span> templates which ensures nice indentation of generated output.</li>
 	</ul>
 
 
 	<ul>
-	<li><code>put_value()</code> now returns the value it puts. Therefore, it is easier to chain together a series of assignments: <code>foo.intVal = bar.intVal = baz.intVal = 10</code></li>
+	<li>The test generator now decouples Ruby-VPI paths from Verilog benches via the <span class="caps">RUBYLIB</span> environment variable.</li>
 	</ul>
 
 
 	<ul>
-	<li><code>put_value()</code> now verifies that the value it puts was written correctly. This helps to find bugs regarding invalid assumptions about the number of bits supported by a signal.</li>
+	<li>A tool which converts Verilog headers into Ruby has been added.</li>
 	</ul>
 
 
@@ -629,7 +722,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release simplifies generated tests and fixes a bug.</p>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -655,19 +748,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds support and documentation for rapid prototyping of Verilog designs in Ruby.</p>
 
 
-	<h2>Details</h2>
-
-
-	<ul>
-	<li>Support for prototyping designs in Ruby, before they are implemented in Verilog, has been added.
-	<ul>
-	<li>The <em>same</em> specification can be used to verify both prototype <em>and</em> design! :-)</li>
-		<li>The tutorial in the user manual has been updated to discuss prototyping.
-	<ul>
-	<li>Prototypes have been added to the counter example.</li>
-	</ul></li>
-	</ul></li>
-	</ul>
+	<h2>Notice</h2>
 
 
 	<ul>
@@ -685,6 +766,21 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
+	<h2>Detail</h2>
+
+
+	<ul>
+	<li>Support for prototyping designs in Ruby, before they are implemented in Verilog, has been added.
+	<ul>
+	<li>The <em>same</em> specification can be used to verify both prototype <em>and</em> design! :-)</li>
+		<li>The tutorial in the user manual has been updated to discuss prototyping.
+	<ul>
+	<li>Prototypes have been added to the counter example.</li>
+	</ul></li>
+	</ul></li>
+	</ul>
+
+
 	<ul>
 	<li>The user manual has been revised for consistency.</li>
 	</ul>
@@ -699,7 +795,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release fixes unreadable syntax coloring in the user manual.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -707,7 +803,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -729,7 +825,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds a tutorial to the user manual, and improves the tools and examples.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -737,7 +833,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<h3>User manual</h3>
@@ -798,7 +894,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release enhances the <span class="caps">VPI</span> utility layer and adds new content to the user manual.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -806,7 +902,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
 
 
 	<ul>
@@ -815,17 +911,20 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 
 
 	<ul>
-	<li>The <span class="caps">VPI</span> utility layer provides access to <span class="caps">VPI</span> properties of handles in a <a href="http://ruby-vpi.rubyforge.org/doc/background.organization.html#organization.vpi">simpler, more powerful way</a>.</li>
+	<li>The <code>handle.value</code> and <code>handle.value=</code> methods have been removed.</li>
 	</ul>
 
 
+	<h2>Detail</h2>
+
+
 	<ul>
-	<li>All <span class="caps">VPI</span> properties, except delay values, are now accessible from a handle.</li>
+	<li>The <span class="caps">VPI</span> utility layer provides access to <span class="caps">VPI</span> properties of handles in a <a href="http://ruby-vpi.rubyforge.org/doc/background.organization.html#organization.vpi">simpler, more powerful way</a>.</li>
 	</ul>
 
 
 	<ul>
-	<li>The <code>handle.value</code> and <code>handle.value=</code> methods have been removed.</li>
+	<li>All <span class="caps">VPI</span> properties, except delay values, are now accessible from a handle.</li>
 	</ul>
 
 
@@ -852,7 +951,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds a comprehensive user manual, upgrades from make to <a href="http://rake.rubyforge.org">Rake</a>, and improves the test generation tool.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -860,21 +959,24 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
 
 
 	<ul>
-	<li>A comprehensive user manual, written in DocBook-XML, has been added.</li>
+	<li>Rake has replaced the role of <strong>make</strong>. All makefiles have been converted accordingly.</li>
 	</ul>
 
 
 	<ul>
-	<li>Rake has replaced the role of <strong>make</strong>. All makefiles have been converted accordingly.</li>
+	<li>The test generation tool now generates multiple files (runner, bench, design, spec) and makes backups of existing files. See its help information for details.</li>
 	</ul>
 
 
+	<h2>Detail</h2>
+
+
 	<ul>
-	<li>The test generation tool now generates multiple files (runner, bench, design, spec) and makes backups of existing files. See its help information for details.</li>
+	<li>A comprehensive user manual, written in DocBook-XML, has been added.</li>
 	</ul>
 
 
@@ -904,7 +1006,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds a tool which generates test benches, and adds support for <a href="http://behaviour-driven.org">Behavior Driven Development</a> via the <a href="http://rspec.rubyforge.org">RSpec</a> library.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -912,7 +1014,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -948,7 +1050,15 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds simple ways of reading and writing values to <span class="caps">VPI</span> handles, adds documentation for the <span class="caps">VPI</span> utility layer, and fixes the pipelined <span class="caps">ALU</span> example.</p>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The <strong>msim</strong> Makefile target for Mentor Modelsim has been renamed back to <strong>vsim</strong>.</li>
+	</ul>
+
+
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -994,7 +1104,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release adds support for the <em>entire</em> <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945"><span class="caps">IEEE</span> Std. 1364-2005</a> VPI interface, and updates the examples into unit tests.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -1002,7 +1112,15 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The <strong>vsim</strong> Makefile target for Mentor Modelsim has been renamed to <strong>msim</strong>.</li>
+	</ul>
+
+
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -1031,10 +1149,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 
 
 	<ul>
-	<li>The makefiles for the examples have been simplified through the use of a common template.
-	<ul>
-	<li>The <strong>vsim</strong> target for Mentor Modelsim has been renamed to <strong>msim</strong>.</li>
-	</ul></li>
+	<li>The makefiles for the examples have been simplified through the use of a common template.</li>
 	</ul>
 
 
@@ -1056,7 +1171,7 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	<p>This release fixes major bugs, adds support for Mentor Modelsim, and removes the <code>$ruby_task</code> callback.</p>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -1064,7 +1179,15 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>Removed <code>$ruby_task</code> callback and ability to dynamically register system tasks from Ruby because inter-process communication is complicated at present.</li>
+	</ul>
+
+
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -1077,11 +1200,6 @@ We <em>strictly</em> follow the RubyGems project&#8217;s <a href="http://www.rub
 	</ul>
 
 
-	<ul>
-	<li>Removed <code>$ruby_task</code> callback and ability to dynamically register system tasks from Ruby because inter-process communication is complicated at present.</li>
-	</ul>
-
-
 	<ul>
 	<li>Added piplelined <span class="caps">ALU</span> example.</li>
 	</ul>
@@ -1111,7 +1229,7 @@ This release adds enough Verilog <span class="caps">VPI</span> functionality to
 	</ul>
 
 
-	<h2>Acknowledgments</h2>
+	<h2>Acknowledgment</h2>
 
 
 	<ul>
@@ -1124,7 +1242,7 @@ This release adds enough Verilog <span class="caps">VPI</span> functionality to
 	</ul>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>
@@ -1184,7 +1302,7 @@ This release adds enough Verilog <span class="caps">VPI</span> functionality to
 	<p>This is Kazuhiro <span class="caps">HIWADA</span>&#8217;s initial testing release of Ruby-VPI. See its <a href="http://www.ruby-talk.org/cgi-bin/scat.rb/ruby/ruby-list/18193">original announcement</a> and <a href="http://easter.kuee.kyoto-u.ac.jp/~hiwada/ruby/memo/src/ruby-vpi-test.tgz">source code</a>.</p>
 
 
-	<h2>Details</h2>
+	<h2>Detail</h2>
 
 
 	<ul>