ruby-vpi 7.3.0 → 8.0.0

data/header.html

@@ -13,8 +13,8 @@
 
 	<ul>
 	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
 		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
+		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
 	</ul>
 
 
@@ -51,7 +51,16 @@
 </span>
 </dt>
 <dd>
-<p>Complete documentation for users. Start here!</p>
+<p>Complete documentation for users. <em>Start here!</em></p>
+</dd>
+
+<dt>
+<span class="term">
+<a href="./ref/" target="_top">Reference</a>
+</span>
+</dt>
+<dd>
+<p><span class="caps">API</span> reference documentation for Ruby libraries and C extension.</p>
 </dd>
 
 <dt>
@@ -66,9 +75,10 @@ Access project facilities, hosted generously by <a href="http://rubyforge.org" t
 RubyForge</a>.
 </p>
 </dd>
+
 <dt>
 <span class="term">
-<a href="http://rubyforge.org/projects/ruby-vpi" target="_top">
+<a href="http://rubyforge.org/tracker/?group_id=1339" target="_top">
 Tracker</a>
 </span>
 </dt>
@@ -76,6 +86,7 @@ Tracker</a>
 <p>
 Report problems, contribute patches, and more.</p>
 </dd>
+
 <dt>
 <span class="term">
 <a href="http://rubyforge.org/frs/?group_id=1339" target="_top">
@@ -86,9 +97,10 @@ Releases</a>
 <p>
 Download the newest releases.</p>
 </dd>
+
 <dt>
 <span class="term">
-<a href="http://rubyforge.org/scm/?group_id=1339" target="_top">
+<a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi" target="_top">
 Sources</a>
 </span>
 </dt>
@@ -96,6 +108,7 @@ Sources</a>
 <p>
 Browse or access the source code repository.</p>
 </dd>
+
 <dt>
 <span class="term">
 <a href="http://rubyforge.org/forum/?group_id=1339" target="_top">
@@ -106,6 +119,7 @@ Forums</a>
 <p>
 Ask for help, give feedback, or discuss.</p>
 </dd>
+
 </dl>
 </div>
 </div>

data/header.part.html

@@ -13,8 +13,8 @@
 
 	<ul>
 	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
 		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
+		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
 	</ul>
 
 
@@ -51,7 +51,16 @@
 </span>
 </dt>
 <dd>
-<p>Complete documentation for users. Start here!</p>
+<p>Complete documentation for users. <em>Start here!</em></p>
+</dd>
+
+<dt>
+<span class="term">
+<a href="./ref/" target="_top">Reference</a>
+</span>
+</dt>
+<dd>
+<p><span class="caps">API</span> reference documentation for Ruby libraries and C extension.</p>
 </dd>
 
 <dt>
@@ -66,9 +75,10 @@ Access project facilities, hosted generously by <a href="http://rubyforge.org" t
 RubyForge</a>.
 </p>
 </dd>
+
 <dt>
 <span class="term">
-<a href="http://rubyforge.org/projects/ruby-vpi" target="_top">
+<a href="http://rubyforge.org/tracker/?group_id=1339" target="_top">
 Tracker</a>
 </span>
 </dt>
@@ -76,6 +86,7 @@ Tracker</a>
 <p>
 Report problems, contribute patches, and more.</p>
 </dd>
+
 <dt>
 <span class="term">
 <a href="http://rubyforge.org/frs/?group_id=1339" target="_top">
@@ -86,9 +97,10 @@ Releases</a>
 <p>
 Download the newest releases.</p>
 </dd>
+
 <dt>
 <span class="term">
-<a href="http://rubyforge.org/scm/?group_id=1339" target="_top">
+<a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi" target="_top">
 Sources</a>
 </span>
 </dt>
@@ -96,6 +108,7 @@ Sources</a>
 <p>
 Browse or access the source code repository.</p>
 </dd>
+
 <dt>
 <span class="term">
 <a href="http://rubyforge.org/forum/?group_id=1339" target="_top">
@@ -106,6 +119,7 @@ Forums</a>
 <p>
 Ask for help, give feedback, or discuss.</p>
 </dd>
+
 </dl>
 </div>
 </div>

data/history.html

@@ -13,8 +13,8 @@
 
 	<ul>
 	<li>Prototype and verify designs <em>quickly</em> using <a href="http://behaviour-driven.org/" title="behavior-driven development"><span class="caps">BDD</span></a>, <a href="http://www.agiledata.org/essays/tdd.html" title="test-driven development"><span class="caps">TDD</span></a>, and more.</li>
-		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
 		<li>Reuse the <em>same</em> specification to verify both prototype and design.</li>
+		<li>Specifications are executable <em>and</em> human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspecTest_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)</li>
 	</ul>
 
 
@@ -51,7 +51,16 @@
 </span>
 </dt>
 <dd>
-<p>Complete documentation for users. Start here!</p>
+<p>Complete documentation for users. <em>Start here!</em></p>
+</dd>
+
+<dt>
+<span class="term">
+<a href="./ref/" target="_top">Reference</a>
+</span>
+</dt>
+<dd>
+<p><span class="caps">API</span> reference documentation for Ruby libraries and C extension.</p>
 </dd>
 
 <dt>
@@ -66,9 +75,10 @@ Access project facilities, hosted generously by <a href="http://rubyforge.org" t
 RubyForge</a>.
 </p>
 </dd>
+
 <dt>
 <span class="term">
-<a href="http://rubyforge.org/projects/ruby-vpi" target="_top">
+<a href="http://rubyforge.org/tracker/?group_id=1339" target="_top">
 Tracker</a>
 </span>
 </dt>
@@ -76,6 +86,7 @@ Tracker</a>
 <p>
 Report problems, contribute patches, and more.</p>
 </dd>
+
 <dt>
 <span class="term">
 <a href="http://rubyforge.org/frs/?group_id=1339" target="_top">
@@ -86,9 +97,10 @@ Releases</a>
 <p>
 Download the newest releases.</p>
 </dd>
+
 <dt>
 <span class="term">
-<a href="http://rubyforge.org/scm/?group_id=1339" target="_top">
+<a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi" target="_top">
 Sources</a>
 </span>
 </dt>
@@ -96,6 +108,7 @@ Sources</a>
 <p>
 Browse or access the source code repository.</p>
 </dd>
+
 <dt>
 <span class="term">
 <a href="http://rubyforge.org/forum/?group_id=1339" target="_top">
@@ -106,6 +119,7 @@ Forums</a>
 <p>
 Ask for help, give feedback, or discuss.</p>
 </dd>
+
 </dl>
 </div>
 </div>
@@ -130,13 +144,81 @@ 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 8.0.0 (2006-10-13)</h1>
+
+
+	<h2>Summary</h2>
+
+
+	<p>This release renames some identifiers for consistency, updates the documentation, and improves integration with RubyGems.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The <code>RubyVPI</code> module has been renamed to <code>RubyVpi</code>.</li>
+	</ul>
+
+
+	<ul>
+	<li>The <code>PROTO</code> environment variable has been renamed to <code>PROTOTYPE</code>.
+	<ul>
+	<li>In addition to using <code>unset</code>, you can now disable simulation of the prototype by assigning an empty value to this variable.</li>
+	</ul></li>
+	</ul>
+
+
+	<h2>Details</h2>
+
+
+	<ul>
+	<li>We now use <a href="http://darcs.net">Darcs</a> for revision control, instead of Subversion. The source repository can now be accessed at <a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi">http://ruby-vpi.rubyforge.org/src/ruby-vpi</a>.</li>
+	</ul>
+
+
+	<ul>
+	<li>The source code is now distributed in tar.gz and zip form, in addition to gem.</li>
+	</ul>
+
+
+	<ul>
+	<li>Some identifiers have been renamed for better consistency.</li>
+	</ul>
+
+
+	<ul>
+	<li>The user manual now resides directly within the <code>doc/</code> directory.
+	<ul>
+	<li>The integration of documentation in <code>gem_server</code> has been improved.</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>The glossary and tutorial in the user manual have been revised.</li>
+	</ul>
+
+
 	<h1>Version 7.3.0 (2006-09-30)</h1>
 
 
 	<h2>Summary</h2>
 
 
-	<p>This release fixes a bug in generated Verilog benches and adds parsed constants to generated Verilog benches and Ruby designs.</p>
+	<p>This release fixes a bug in generated Verilog benches, includes parsed constants in generated tests, and adds new methods to handles.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<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>
+	</ul></li>
+	</ul>
 
 
 	<h2>Details</h2>

data/history.part.html

@@ -18,13 +18,81 @@ 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 8.0.0 (2006-10-13)</h1>
+
+
+	<h2>Summary</h2>
+
+
+	<p>This release renames some identifiers for consistency, updates the documentation, and improves integration with RubyGems.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<ul>
+	<li>The <code>RubyVPI</code> module has been renamed to <code>RubyVpi</code>.</li>
+	</ul>
+
+
+	<ul>
+	<li>The <code>PROTO</code> environment variable has been renamed to <code>PROTOTYPE</code>.
+	<ul>
+	<li>In addition to using <code>unset</code>, you can now disable simulation of the prototype by assigning an empty value to this variable.</li>
+	</ul></li>
+	</ul>
+
+
+	<h2>Details</h2>
+
+
+	<ul>
+	<li>We now use <a href="http://darcs.net">Darcs</a> for revision control, instead of Subversion. The source repository can now be accessed at <a href="http://ruby-vpi.rubyforge.org/src/ruby-vpi">http://ruby-vpi.rubyforge.org/src/ruby-vpi</a>.</li>
+	</ul>
+
+
+	<ul>
+	<li>The source code is now distributed in tar.gz and zip form, in addition to gem.</li>
+	</ul>
+
+
+	<ul>
+	<li>Some identifiers have been renamed for better consistency.</li>
+	</ul>
+
+
+	<ul>
+	<li>The user manual now resides directly within the <code>doc/</code> directory.
+	<ul>
+	<li>The integration of documentation in <code>gem_server</code> has been improved.</li>
+	</ul></li>
+	</ul>
+
+
+	<ul>
+	<li>The glossary and tutorial in the user manual have been revised.</li>
+	</ul>
+
+
 	<h1>Version 7.3.0 (2006-09-30)</h1>
 
 
 	<h2>Summary</h2>
 
 
-	<p>This release fixes a bug in generated Verilog benches and adds parsed constants to generated Verilog benches and Ruby designs.</p>
+	<p>This release fixes a bug in generated Verilog benches, includes parsed constants in generated tests, and adds new methods to handles.</p>
+
+
+	<h2>Notice</h2>
+
+
+	<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>
+	</ul></li>
+	</ul>
 
 
 	<h2>Details</h2>

data/lib/ruby-vpi.rb

@@ -19,17 +19,17 @@
 =end
 
 # Provides configuration information of the Ruby-VPI project.
-module RubyVPI
+module RubyVpi
   # Initializes the current bench using the given parameters.
-  def RubyVPI.init_bench aTestPrefix, aProtoClassId
+  def RubyVpi.init_bench aTestPrefix, aProtoClassId
     require 'ruby-vpi/vpi_util'
     Vpi::relay_verilog	# service the $ruby_init() callback
 
     # set up code coverage analysis
-      if ENV['COVERAGE']
+      unless (ENV['COVERAGE'] || '').empty?
         require 'ruby-vpi/rcov'
 
-        RubyVPI.with_coverage_analysis do |a|
+        RubyVpi.with_coverage_analysis do |a|
           a.dump_coverage_info [
             Rcov::TextReport.new,
             Rcov::HTMLCoverage.new(:destdir => "#{aTestPrefix}_coverage")
@@ -40,7 +40,7 @@ module RubyVPI
     # load the design under test
       require "#{aTestPrefix}_design.rb"
 
-      if ENV['PROTO']
+      unless (ENV['PROTOTYPE'] || '').empty?
         require "#{aTestPrefix}_proto.rb"
 
         proto = Kernel.const_get(aProtoClassId).new

data/lib/ruby-vpi/rcov.rb

@@ -39,7 +39,7 @@ require 'rcov'
 require 'rcov/report'
 
 
-module RubyVPI
+module RubyVpi
   COVERAGE_ANALYSIS = Rcov::CodeCoverageAnalyzer.new
   COVERAGE_ANALYSIS.install_hook
 
@@ -54,7 +54,7 @@ module RubyVPI
   end
 
   # Invokes the given block after code coverage analysis has completed.
-  def RubyVPI.with_coverage_analysis &aBlock # :yields: Rcov::CodeCoverageAnalyzer
+  def RubyVpi.with_coverage_analysis &aBlock # :yields: Rcov::CodeCoverageAnalyzer
     if aBlock
       COVERAGE_ANALYSIS_HANDLERS << aBlock
     end

data/lib/ruby-vpi/runner.rb

@@ -38,20 +38,17 @@
 require 'rake/clean'
 require 'ruby-vpi/rake'
 
-LIBRARY_PATH = File.join(File.dirname(__FILE__), '..')
-OBJECT_PATH = File.join(LIBRARY_PATH, '..', 'obj')
-
-# make Ruby-VPI libraries available to spec
-  ENV['RUBYLIB'] = (ENV['RUBYLIB'] && ENV['RUBYLIB'].dup || '') << ":#{LIBRARY_PATH}"
-
+OBJECT_PATH = File.join(File.dirname(__FILE__), '..', '..', 'obj')
 
 # Returns the path to the Ruby-VPI object file for the given simulator.
 def object_file_path aSimId, aShared = false
   path = File.join(OBJECT_PATH, "ruby-vpi.#{aSimId}.#{aShared ? 'so' : 'o'}")
-  raise "Object file `#{path}' is missing.\n Please build Ruby-VPI to generate the missing file." unless File.exist? path
+  raise "Object file #{path.inspect} is missing.\n Rebuild Ruby-VPI to generate the missing file." unless File.exist? path
   path
 end
 
+
+desc "Show a list of available tasks."
 task :default do
   Rake.application.options.show_task_pattern = //
   Rake.application.display_tasks_and_comments