ruby-vpi 16.0.1 → 17.0.0

data/doc/memo.doc

@@ -1,63 +1,65 @@
-h1. Pending tasks
+<doc_proxy_include common.inc>
 
-* add shortcuts for reading & writing VPI delay values
+<% section "Pending tasks" do %>
+  * add shortcuts for reading & writing VPI delay values
 
-* GHDL simulator supports VPI
-** need way to invoke VPI tasks from VHDL, like @$ruby_init();@
+  * GHDL simulator supports VPI
+  ** need way to invoke VPI tasks from VHDL, like @$ruby_init();@
 
-  +No need for system tasks/functions. Ruby-VPI uses callbacks now!+
+    +No need for system tasks/functions. Ruby-VPI uses callbacks now!+
 
-* add instructions for using *ruby-debug* with a graphical debugging tool or IDE like RadRails
+  * add instructions for using *ruby-debug* with a graphical debugging tool or IDE like RadRails
 
-* write section about code coverage and prototyping in manual
+  * write section about code coverage and prototyping in manual
 
-* clean up the teriminology section... unnecessary
+  * clean up the teriminology section... unnecessary
 
-* write unit tests for the non-VPI libraries like integer.rb and float.rb
+  * write unit tests for the non-VPI libraries like integer.rb and float.rb
+<% end %>
 
 
-h1. Finished tasks
+<% section "Finished tasks" do %>
+  * add support for ESL prototyping (like SystemC)
 
-* add support for ESL prototyping (like SystemC)
+  * decouple code generation with $RUBYLIB and erb
 
-* decouple code generation with $RUBYLIB and erb
+  * change should_be to should_equal in examples
 
-* change should_be to should_equal in examples
+  * add support for GPL Cver in the test runner template
 
-* add support for GPL Cver in the test runner template
+  * build ruby-vpi once to generate all .so files
+  ** test runner should not rebuild ruby-vpi every time
 
-* build ruby-vpi once to generate all .so files
-** test runner should not rebuild ruby-vpi every time
+  * distribute as a GEM, binary, and source
+  ** use RUBYLIB to bypass rubygems site installation for local testing. otherwise have to build & install gem _every_ time!
+  ** move stuff from lib/ into lib/ruby-vpi/
 
-* distribute as a GEM, binary, and source
-** use RUBYLIB to bypass rubygems site installation for local testing. otherwise have to build & install gem _every_ time!
-** move stuff from lib/ into lib/ruby-vpi/
+  * integrate RCov for code-coverage statistics
 
-* integrate RCov for code-coverage statistics
+  * method_missing for Design class
 
-* method_missing for Design class
+  * define handled methods in Vpi::method_missing for faster response
+  ** this has been verified as bottleneck from profiling data
 
-* define handled methods in Vpi::method_missing for faster response
-** this has been verified as bottleneck from profiling data
+  * make RCov correctly profile the code and report useful coverage metrics...
 
-* make RCov correctly profile the code and report useful coverage metrics...
+  * add support for VPI callbacks which execute Ruby blocks
+<% end %>
 
-* add support for VPI callbacks which execute Ruby blocks
 
+<% section "Obsolete tasks" do %>
+  * smarter test generation, which adjusts to user modifications in previously generated output
 
-h1. Obsolete tasks
+    +Just use a smart merging tool like *kdiff3*.+
 
-* smarter test generation, which adjusts to user modifications in previously generated output
+  * interactive console IRB wrapper for spec (just like Breakpoints in Rails)
 
-  +Just use a smart merging tool like *kdiff3*.+
+    +Use the *ruby-debug* library with "*debugger* command for breakpoints":http://www.datanoise.com/articles/category/ruby-debug instead!+
 
-* interactive console IRB wrapper for spec (just like Breakpoints in Rails)
+  * need to dump signal values when expectation fails in rSpec
 
-  +Use the *ruby-debug* library with "*debugger* command for breakpoints":http://www.datanoise.com/articles/category/ruby-debug instead!+
+    +You can use the interactive debugger instead.+
+  ** maybe a waveform dump will also help
 
-* 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.+
+    +After reading some RTL verification books, this is not necessarily true.+
+<% end %>

data/doc/memo.html

@@ -8,31 +8,33 @@
     <title>Pending tasks</title>
   </head>
   <body>
-      <h1 style="margin-top: 0">Pending tasks</h1>
-
-    <p style="text-align:center;"><a href="readme.html"><img src="images/tango/home.png" title="Return to main page" alt="Return to main page" /></a></p>
-
-    <div id="menu">
-      <a href="#index">Contents</a>
+      <div id="toc-links">
+                    <a href="#toc:contents">Contents</a> &middot;
+      
+      <a href="readme.html" style="color: green; font-size: larger;">Home page</a>
     </div>
+  
+    <div id="body"><p>
+      <hr style="display: none"/>
 
-    <div id="index">
-      <h1>Contents</h1>
-      <ul><li><a id="a-606759078" href="#Pending_tasks">Pending tasks</a></li><li><a id="a-606760118" href="#Finished_tasks">Finished tasks</a></li><li><a id="a-606761088" href="#Obsolete_tasks">Obsolete tasks</a></li></ul>
+      <div id="Pending_tasks" class="section">
+        <h1 class="title">
+          <a href="#a-606651978">1</a>
 
-          </div>
-      <h1><a id="Pending_tasks" href="#a-606759078">1</a> &nbsp; Pending tasks</h1>
+          &nbsp;
 
+          Pending tasks
+        </h1>
 
-	<ul>
-	<li>add shortcuts for reading &#38; writing <span class="caps">VPI</span> delay values</li>
+        <ul>
+	<li>add shortcuts for reading &#38; writing VPI delay values</li>
 	</ul>
 
 
 	<ul>
-	<li><span class="caps">GHDL</span> simulator supports <span class="caps">VPI</span>
+	<li>GHDL simulator supports VPI
 	<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>need way to invoke VPI tasks from VHDL, like <code class="code"><span style="color:#d70; font-weight:bold">$ruby_init</span>();</code>
 
 	<p><ins>No need for system tasks/functions. Ruby-VPI uses callbacks now!</ins></p></li>
 	</ul></li>
@@ -40,7 +42,7 @@
 
 
 	<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>add instructions for using <strong>ruby-debug</strong> with a graphical debugging tool or IDE like RadRails</li>
 	</ul>
 
 
@@ -58,12 +60,24 @@
 	<li>write unit tests for the non-VPI libraries like integer.rb and float.rb</li>
 	</ul>
 
+      </div>
+    </p>
 
-	<h1><a id="Finished_tasks" href="#a-606760118">2</a> &nbsp; Finished tasks</h1>
 
+	<p>
+      <hr style="display: none"/>
 
-	<ul>
-	<li>add support for <span class="caps">ESL</span> prototyping (like SystemC)</li>
+      <div id="Finished_tasks" class="section">
+        <h1 class="title">
+          <a href="#a-606657678">2</a>
+
+          &nbsp;
+
+          Finished tasks
+        </h1>
+
+        <ul>
+	<li>add support for ESL prototyping (like SystemC)</li>
 	</ul>
 
 
@@ -78,7 +92,7 @@
 
 
 	<ul>
-	<li>add support for <span class="caps">GPL</span> Cver in the test runner template</li>
+	<li>add support for GPL Cver in the test runner template</li>
 	</ul>
 
 
@@ -91,9 +105,9 @@
 
 
 	<ul>
-	<li>distribute as a <span class="caps">GEM</span>, binary, and source
+	<li>distribute as a GEM, binary, and source
 	<ul>
-	<li>use <span class="caps">RUBYLIB</span> to bypass rubygems site installation for local testing. otherwise have to build &#38; install gem <em>every</em> time!</li>
+	<li>use RUBYLIB to bypass rubygems site installation for local testing. otherwise have to build &#38; install gem <em>every</em> time!</li>
 		<li>move stuff from lib/ into lib/ruby-vpi/</li>
 	</ul></li>
 	</ul>
@@ -123,14 +137,26 @@
 
 
 	<ul>
-	<li>add support for <span class="caps">VPI</span> callbacks which execute Ruby blocks</li>
+	<li>add support for VPI callbacks which execute Ruby blocks</li>
 	</ul>
 
+      </div>
+    </p>
 
-	<h1><a id="Obsolete_tasks" href="#a-606761088">3</a> &nbsp; Obsolete tasks</h1>
 
+	<p>
+      <hr style="display: none"/>
 
-	<ul>
+      <div id="Obsolete_tasks" class="section">
+        <h1 class="title">
+          <a href="#a-606663598">3</a>
+
+          &nbsp;
+
+          Obsolete tasks
+        </h1>
+
+        <ul>
 	<li>smarter test generation, which adjusts to user modifications in previously generated output
 
 	<p><ins>Just use a smart merging tool like <strong>kdiff3</strong>.</ins></p></li>
@@ -138,7 +164,7 @@
 
 
 	<ul>
-	<li>interactive console <span class="caps">IRB</span> wrapper for spec (just like Breakpoints in Rails)
+	<li>interactive console IRB wrapper for spec (just like Breakpoints in Rails)
 
 	<p><ins>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!</ins></p></li>
 	</ul>
@@ -152,8 +178,18 @@
 	<ul>
 	<li>maybe a waveform dump will also help
 
-	<p><ins>After reading some <span class="caps">RTL</span> verification books, this is not necessarily true.</ins></p></li>
+	<p><ins>After reading some RTL verification books, this is not necessarily true.</ins></p></li>
 	</ul></li>
 	</ul>
-  </body>
+
+      </div>
+    </p></div>
+
+      <hr style="display: none"/>
+    <div id="toc">
+      <h1 id="toc:contents">Contents</h1>
+      <ul><li><span class="hide">1 </span><a id="a-606651978" href="#Pending_tasks">Pending tasks</a></li><li><span class="hide">2 </span><a id="a-606657678" href="#Finished_tasks">Finished tasks</a></li><li><span class="hide">3 </span><a id="a-606663598" href="#Obsolete_tasks">Obsolete tasks</a></li></ul>
+
+          </div>
+    </body>
 </html>

data/doc/readme.doc

@@ -1,39 +1,12 @@
+<doc_proxy_include common.inc>
 <%
   insert_toc = false
   page_title = "Ruby-VPI: Ruby interface to Verilog VPI"
 %>
 
-<style type="text/css">
-  body {
-    margin-left: 275px;
-    padding-right: 1em;
-  }
-
-  #resources {
-    position: absolute;
-    left: 0;
-    top: 0;
-    width: 200px;
-    padding: 1em;
-
-    border: thin solid red;
-    border-left: none;
-    border-top: none;
-    background-color: snow;
-  }
-
-  #resources li {
-    margin-top: 1em;
-    margin-left: -1em;
-  }
-
-  #resources h2 {
-    display: none;
-  }
-</style>
-
-h1{margin-top: 0}. Ruby-VPI
+<div style="float: right">Version <%= version %></div>
+<h1 style="padding-top: 0">Ruby-VPI</h1>
 
 <a href="http://www.ruby-lang.org"><img src="images/ruby/logo-reflection.png" alt="Logo of the Ruby programming language" style="margin: 0; margin-left: 2em; float: right"/></a>
 
-<%= import 'intro.inc' %>
+<doc_proxy_include intro.inc>