ruby-vpi 13.0.0 → 14.0.0

data/doc/memo.doc

@@ -1,18 +1,17 @@
 h1. Pending tasks
 
-* add support for VPI callbacks which execute Ruby blocks
-
 * add support for reading & writing VPI delay values
 
 * GHDL simulator supports VPI
-** need way to invoke VPI tasks from VHDL, like @$ruby_init();@
-
-* need to dump signal values when expectation fails in rSpec
-** maybe a waveform dump will also help
-** this will help in debugging the problem
+** -need way to invoke VPI tasks from VHDL, like @$ruby_init();@-
+No need for tasks; Ruby-VPI uses callbacks now!
 
 * add instructions for using *ruby-debug* with a graphical debugging tool or IDE like RadRails
 
+* write section about code coverage and prototyping in manual
+
+* clean up the teriminology section... unnecessary
+
 
 h1. Finished tasks
 
@@ -40,16 +39,17 @@ h1. Finished tasks
 
 * make RCov correctly profile the code and report useful coverage metrics...
 
+* add support for VPI callbacks which execute Ruby blocks
 
-h1. Obsolete tasks
-
-* smarter test generation, which adjusts to user modifications in previously generated output -- just use a smart merging tool like *kdiff3*
-
-* interactive console IRB wrapper for spec (just like Breakpoints in Rails)
-** use the *ruby-debug* library with "*debugger* command for breakpoints":http://www.datanoise.com/articles/category/ruby-debug instead!
 
+h1. Obsolete tasks
 
-h1. Notes
+* -smarter test generation, which adjusts to user modifications in previously generated output-
+Just use a smart merging tool like *kdiff3*.
 
-* When within Rake, rubygems is automatically available for use. no need to require() it again
+* -interactive console IRB wrapper for spec (just like Breakpoints in Rails)- Use the *ruby-debug* library with "*debugger* command for breakpoints":http://www.datanoise.com/articles/category/ruby-debug instead!
 
+* -need to dump signal values when expectation fails in rSpec-
+You can use the interactive debugger instead.
+** -maybe a waveform dump will also help-
+After reading some RTL verification books, this is not necessarily true.

data/doc/memo.html

@@ -12,10 +12,9 @@
 
       <h1>Contents</h1>
       <ul>
-	<li><a href="#anchor1">Pending tasks</a></li>
-		<li><a href="#anchor2">Finished tasks</a></li>
-		<li><a href="#anchor3">Obsolete tasks</a></li>
-		<li><a href="#anchor4">Notes</a></li>
+	<li>1 <a href="#anchor1">Pending tasks</a></li>
+		<li>2 <a href="#anchor2">Finished tasks</a></li>
+		<li>3 <a href="#anchor3">Obsolete tasks</a></li>
 	</ul>
 
               <h1>Admonitions</h1>
@@ -23,12 +22,7 @@
                                                                                                                 <h1>Formals</h1>
 
                                                                                                             </div>
-      <h1 id="anchor1">Pending tasks</h1>
-
-
-	<ul>
-	<li>add support for <span class="caps">VPI</span> callbacks which execute Ruby blocks</li>
-	</ul>
+      <h1 id="anchor1">1 &nbsp; Pending tasks</h1>
 
 
 	<ul>
@@ -39,26 +33,28 @@
 	<ul>
 	<li><span class="caps">GHDL</span> simulator supports <span class="caps">VPI</span>
 	<ul>
-	<li>need way to invoke <span class="caps">VPI</span> tasks from <span class="caps">VHDL</span>, like <code class="code"><span style="color:#d70; font-weight:bold">$ruby_init</span>();</code></li>
+	<li><del>need way to invoke <span class="caps">VPI</span> tasks from <span class="caps">VHDL</span>, like <code class="code"><span style="color:#d70; font-weight:bold">$ruby_init</span>();</code></del>
+No need for tasks; Ruby-VPI uses callbacks now!</li>
 	</ul></li>
 	</ul>
 
 
 	<ul>
-	<li>need to dump signal values when expectation fails in rSpec
+	<li>add instructions for using <strong>ruby-debug</strong> with a graphical debugging tool or <span class="caps">IDE</span> like RadRails</li>
+	</ul>
+
+
 	<ul>
-	<li>maybe a waveform dump will also help</li>
-		<li>this will help in debugging the problem</li>
-	</ul></li>
+	<li>write section about code coverage and prototyping in manual</li>
 	</ul>
 
 
 	<ul>
-	<li>add instructions for using <strong>ruby-debug</strong> with a graphical debugging tool or <span class="caps">IDE</span> like RadRails</li>
+	<li>clean up the teriminology section&#8230; unnecessary</li>
 	</ul>
 
 
-	<h1 id="anchor2">Finished tasks</h1>
+	<h1 id="anchor2">2 &nbsp; Finished tasks</h1>
 
 
 	<ul>
@@ -121,27 +117,32 @@
 	</ul>
 
 
-	<h1 id="anchor3">Obsolete tasks</h1>
-
-
 	<ul>
-	<li>smarter test generation, which adjusts to user modifications in previously generated output&#8212;just use a smart merging tool like <strong>kdiff3</strong></li>
+	<li>add support for <span class="caps">VPI</span> callbacks which execute Ruby blocks</li>
 	</ul>
 
 
+	<h1 id="anchor3">3 &nbsp; Obsolete tasks</h1>
+
+
 	<ul>
-	<li>interactive console <span class="caps">IRB</span> wrapper for spec (just like Breakpoints in Rails)
-	<ul>
-	<li>use the <strong>ruby-debug</strong> library with <a href="http://www.datanoise.com/articles/category/ruby-debug"><strong>debugger</strong> command for breakpoints</a> instead!</li>
-	</ul></li>
+	<li><del>smarter test generation, which adjusts to user modifications in previously generated output</del>
+Just use a smart merging tool like <strong>kdiff3</strong>.</li>
 	</ul>
 
 
-	<h1 id="anchor4">Notes</h1>
+	<ul>
+	<li><del>interactive console <span class="caps">IRB</span> wrapper for spec (just like Breakpoints in Rails)</del> Use the <strong>ruby-debug</strong> library with <a href="http://www.datanoise.com/articles/category/ruby-debug"><strong>debugger</strong> command for breakpoints</a> instead!</li>
+	</ul>
 
 
 	<ul>
-	<li>When within Rake, rubygems is automatically available for use. no need to require() it again</li>
+	<li><del>need to dump signal values when expectation fails in rSpec</del>
+You can use the interactive debugger instead.
+	<ul>
+	<li><del>maybe a waveform dump will also help</del>
+After reading some <span class="caps">RTL</span> verification books, this is not necessarily true.</li>
+	</ul></li>
 	</ul>
   </body>
 </html>

data/doc/readme.doc

@@ -1,6 +1,8 @@
 <% table_of_contents = false %>
 <div id="navigation">
 
+<a type="application/rss+xml" href="<%= RSS_URL %>">!images/feed-icon.png(<%= RSS_INFO %>)!</a>
+
 * "Tutorial":manual.html#usage.tutorial
   - learn how to use Ruby-VPI quickly.
 
@@ -40,7 +42,5 @@
 
 
 h1. Welcome to Ruby-VPI
-<a type="application/rss+xml" href="<%= RSS_URL %>">!images/feed-icon.png(<%= RSS_INFO %>)!</a>
-
 
 <%= File.read 'intro.inc' %>

data/doc/readme.html

@@ -9,6 +9,9 @@
   <body>
       <div id="navigation">
 
+	<p><a type="application/rss+xml" href="http://ruby-vpi.rubyforge.org/doc/rss.xml"><img src="images/feed-icon.png" title="RSS feed for this project." alt="RSS feed for this project." /></a></p>
+
+
 	<ul>
 	<li><a href="manual.html#usage.tutorial">Tutorial</a>
   &#8211; learn how to use Ruby-VPI quickly.</li>
@@ -71,16 +74,16 @@
 
 </div>
 
-	<h1 id="anchor113">Welcome to Ruby-VPI
-<a type="application/rss+xml" href="http://ruby-vpi.rubyforge.org/doc/rss.xml"><img src="images/feed-icon.png" title="RSS feed for this project." alt="RSS feed for this project." /></a></h1>
+	<h1 id="anchor122">1 &nbsp; Welcome to Ruby-VPI</h1>
 
 
-	<blockquote>
-		<p>Ruby-VPI is a <a href="http://www.ruby-lang.org">Ruby</a> interface to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945">Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
-	</blockquote>
+	<p>Ruby-VPI is a <a href="http://www.ruby-lang.org">Ruby</a> interface to <a href="http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945"><span class="caps">IEEE 1364</span>-2005 Verilog <span class="caps">VPI</span></a>. It lets you create complex Verilog test benches easily and wholly in Ruby.</p>
+
+
+	<h2 id="intro.features">1.1 &nbsp; Features</h2>
 
 
-	<h2 id="intro.features">Features</h2>
+	<h3 id="anchor123">1.1.1 &nbsp; Portable</h3>
 
 
 	<ul>
@@ -91,11 +94,14 @@
 	<ul>
 	<li>Works with all <a href="manual.html#setup.reqs">major Verilog simulators</a> available today.
 	<ul>
-	<li>Compile <em>once</em> (during <a href="manual.html#setup.installation">installation</a>) and use forever!</li>
+	<li>Compiled <em>just once</em> during <a href="manual.html#setup.installation">installation</a> and used forever!</li>
 	</ul></li>
 	</ul>
 
 
+	<h3 id="anchor124">1.1.2 &nbsp; Agile</h3>
+
+
 	<ul>
 	<li>Enables <a href="http://agilemanifesto.org/">agile practices</a> such as
 	<ul>
@@ -109,14 +115,18 @@
 	<ul>
 	<li>Eliminates unneccesary work:
 	<ul>
-	<li><a href="manual.html#usage.tutorial.specification">Specifications</a> are <em>readable</em>, portable, and executable.</li>
+	<li><a href="manual.html#usage.tutorial.specification">Specifications</a> are readable, portable, and <em>executable</em>.</li>
 		<li>The <a href="manual.html#usage.tools.generate-test">automated test generator</a> helps you accomodate design changes with <em>minimal</em> effort.</li>
+		<li>There is absolutely <em>no compiling</em>!</li>
 	</ul></li>
 	</ul>
 
 
+	<h3 id="anchor125">1.1.3 &nbsp; Powerful</h3>
+
+
 	<ul>
-	<li>Utilizes the <a href="http://www.ruby-lang.org/en/about/">power and elegance</a> of Ruby:
+	<li>Inherits the <a href="http://www.ruby-lang.org/en/about/">power and elegance</a> of Ruby:
 	<ul>
 	<li>Unlimited length integers</li>
 		<li>Regular expressions</li>
@@ -127,29 +137,55 @@
 	</ul>
 
 
+	<ul>
+	<li>Uses <a href="http://rubyforge.org/projects/ruby-debug/">ruby-debug</a> for <a href="manual.html#usage.debugger">interactive debugging</a>.</li>
+		<li>Uses <a href="http://eigenclass.org/hiki.rb?rcov">rcov</a> for test <a href="manual.html#usage.test-runner.env-vars">coverage analysis and report generation</a>.</li>
+	</ul>
+
+
+	<h3 id="anchor126">1.1.4 &nbsp; Free</h3>
+
+
 	<ul>
 	<li>Gives you the <em>freedom</em> to study, modify, and distribute this software, in accordance with the <a href="http://www.gnu.org/copyleft/gpl.html"><span class="caps">GNU</span> General Public License</a>.</li>
 	</ul>
 
 
-	<h3 id="intro.applications">Applications</h3>
+	<h2 id="intro.applications">1.2 &nbsp; Applications</h2>
+
+
+	<p>Here is a modest sampling of tasks that Ruby-VPI can be used to perform.</p>
 
 
-	<p>Here is a modest sampling of tasks, paraphrased from <a href="http://embedded.eecs.berkeley.edu/Alumni/pinhong/scriptEDA/">Pin Hong</a>, that Ruby-VPI can be used to perform.</p>
+	<ul>
+	<li>From the second edition of <a href="http://www.sutherland-hdl.com/publications.html"><em>The Verilog <span class="caps">PLI</span> Handbook</em></a>:
+	<ul>
+	<li>C language bus-functional models</li>
+		<li>Reading test vector files</li>
+		<li>Delay calculation</li>
+		<li>Custom output displays</li>
+		<li>Co-simulation</li>
+		<li>Design debug utilities</li>
+		<li>Simulation analysis</li>
+	</ul></li>
+	</ul>
 
 
+	<ul>
+	<li>Adapted from <a href="http://embedded.eecs.berkeley.edu/Alumni/pinhong/scriptEDA/">Pin Hong&#8217;s</a> observations:
 	<ul>
 	<li>Writing hardware models in Ruby</li>
-		<li>Dumping/processing netlist data from Verilog database</li>
-		<li>Dumping/processing simulation data</li>
+		<li>Dumping or processing netlist data from Verilog database</li>
+		<li>Dumping or processing simulation data</li>
 		<li>Feeding dynamic simulation stimuli</li>
 		<li>Back-annotating delay information</li>
 		<li>Interactive logic simulation</li>
 		<li>Building a distributed simulation</li>
+	</ul></li>
 	</ul>
 
 
-	<h3 id="intro.appetizers">Appetizers</h3>
+	<h2 id="intro.appetizers">1.3 &nbsp; Appetizers</h2>
 
 
 	<p>Here is a modest sampling of code to whet your appetite.</p>
@@ -191,7 +227,7 @@
 
 
 	<blockquote>
-		<p><code class="code"><span style="color:#00D; font-weight:bold">15</span>.times { relay_verilog }</code></p>
+		<p><code class="code"><span style="color:#00D; font-weight:bold">15</span>.times { simulate }</code></p>
 	</blockquote>
   </body>
 </html>

data/doc/rss.erb

@@ -22,7 +22,7 @@
     <title>Version <%= entry['Version'] %> released</title>
     <link><%= link %></link>
     <guid><%= link %></guid>
-    <description><%=ERB::Util.h entry['Summary'].redcloth %></description>
+    <description><%=ERB::Util.h format_history_entry(entry).to_html %></description>
     <pubDate><%= rfc822 %></pubDate>
   </item>
 <% end %>