ruby-vpi 11.1.0 → 11.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (292) hide show
  1. data/Rakefile +8 -37
  2. data/bin/generate_test_tpl/bench.v +1 -1
  3. data/doc/{src/LICENSE → LICENSE} +0 -0
  4. data/doc/Rakefile +39 -14
  5. data/doc/common.css +144 -0
  6. data/doc/common.tpl +49 -0
  7. data/doc/figures/figures.dia +1589 -0
  8. data/doc/history.erb +18 -0
  9. data/doc/history.html +1726 -0
  10. data/doc/history.rb +14 -0
  11. data/doc/history.yml +686 -0
  12. data/doc/images/{COPYING → LICENSE} +0 -0
  13. data/doc/intro.inc +48 -0
  14. data/doc/lib/doc_format.rb +62 -0
  15. data/doc/lib/doc_proxy.rb +160 -0
  16. data/doc/lib/erb_content.rb +67 -0
  17. data/doc/lib/erb_proxy.rb +48 -0
  18. data/doc/manual.erb +768 -0
  19. data/doc/manual.html +2107 -0
  20. data/doc/manual.rb +5 -0
  21. data/{MEMO → doc/memo.erb} +0 -0
  22. data/{memo.part.html → doc/memo.html} +38 -5
  23. data/doc/readme.erb +36 -0
  24. data/doc/readme.html +171 -0
  25. data/index.html +1 -0
  26. data/lib/ruby-vpi/float.rb +52 -0
  27. data/lib/ruby-vpi/rspec.rb +6 -1
  28. data/lib/ruby-vpi/verilog_parser.rb +4 -5
  29. data/ref/c/annotated.html +1 -6
  30. data/ref/c/common_8h.html +1 -1
  31. data/ref/c/files.html +1 -3
  32. data/ref/c/functions.html +24 -44
  33. data/ref/c/functions_vars.html +24 -44
  34. data/ref/c/globals.html +5 -211
  35. data/ref/c/globals_0x63.html +32 -49
  36. data/ref/c/globals_0x65.html +3 -10
  37. data/ref/c/globals_0x66.html +3 -20
  38. data/ref/c/globals_0x70.html +19 -26
  39. data/ref/c/globals_0x72.html +4 -15
  40. data/ref/c/globals_0x73.html +13 -199
  41. data/ref/c/globals_0x74.html +2 -9
  42. data/ref/c/globals_0x76.html +415 -426
  43. data/ref/c/globals_0x78.html +3 -10
  44. data/ref/c/globals_defs.html +30 -35
  45. data/ref/c/globals_defs_0x65.html +2 -7
  46. data/ref/c/globals_defs_0x70.html +3 -8
  47. data/ref/c/globals_defs_0x76.html +413 -420
  48. data/ref/c/globals_defs_0x78.html +2 -7
  49. data/ref/c/globals_enum.html +1 -1
  50. data/ref/c/globals_eval.html +1 -1
  51. data/ref/c/globals_func.html +14 -173
  52. data/ref/c/globals_type.html +26 -29
  53. data/ref/c/globals_vars.html +4 -88
  54. data/ref/c/index.html +1 -1
  55. data/ref/c/relay_8c.html +1 -1
  56. data/ref/c/relay_8h.html +1 -1
  57. data/ref/c/structrelay____RubyOptions____def.html +1 -1
  58. data/ref/c/structt__cb__data.html +6 -23
  59. data/ref/c/structt__vpi__delay.html +3 -20
  60. data/ref/c/structt__vpi__error__info.html +3 -71
  61. data/ref/c/structt__vpi__strengthval.html +3 -3
  62. data/ref/c/structt__vpi__systf__data.html +12 -46
  63. data/ref/c/structt__vpi__time.html +3 -3
  64. data/ref/c/structt__vpi__value.html +3 -113
  65. data/ref/c/structt__vpi__vecval.html +3 -3
  66. data/ref/c/structt__vpi__vlog__info.html +3 -54
  67. data/ref/c/swig_8c.html +2 -2
  68. data/ref/c/swig_8h.html +1 -1
  69. data/ref/c/verilog_8h.html +1 -1
  70. data/ref/c/vlog_8c.html +1 -1
  71. data/ref/c/vlog_8h.html +1 -1
  72. data/ref/c/vpi__user_8h.html +16 -16
  73. data/ref/ruby/classes/ERB.html +5 -5
  74. data/ref/ruby/classes/ERB.src/{M000034.html → M000036.html} +0 -0
  75. data/ref/ruby/classes/FileUtils.html +10 -10
  76. data/ref/ruby/classes/FileUtils.src/{M000081.html → M000083.html} +0 -0
  77. data/ref/ruby/classes/FileUtils.src/{M000082.html → M000084.html} +0 -0
  78. data/ref/ruby/classes/Float.html +140 -0
  79. data/ref/ruby/classes/Float.src/M000031.html +19 -0
  80. data/ref/ruby/classes/RDoc.html +5 -5
  81. data/ref/ruby/classes/RDoc.src/{M000095.html → M000097.html} +0 -0
  82. data/ref/ruby/classes/RubyVpi.html +10 -10
  83. data/ref/ruby/classes/RubyVpi.src/{M000083.html → M000085.html} +0 -0
  84. data/ref/ruby/classes/RubyVpi.src/{M000084.html → M000086.html} +0 -0
  85. data/ref/ruby/classes/String.html +33 -10
  86. data/ref/ruby/classes/String.src/M000033.html +28 -5
  87. data/ref/ruby/classes/String.src/M000034.html +18 -0
  88. data/ref/ruby/classes/String.src/M000035.html +36 -0
  89. data/ref/ruby/classes/Template.html +5 -5
  90. data/ref/ruby/classes/Template.src/{M000031.html → M000032.html} +0 -0
  91. data/ref/ruby/classes/VerilogParser/Module.src/M000006.html +9 -8
  92. data/ref/ruby/classes/VerilogParser/Module/Parameter.src/M000011.html +5 -7
  93. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000007.html +7 -7
  94. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000008.html +4 -4
  95. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000009.html +4 -4
  96. data/ref/ruby/classes/VerilogParser/Module/Port.src/M000010.html +4 -4
  97. data/ref/ruby/classes/Vpi/Handle.html +46 -46
  98. data/ref/ruby/classes/Vpi/Handle.src/M000087.html +5 -9
  99. data/ref/ruby/classes/Vpi/Handle.src/M000088.html +5 -31
  100. data/ref/ruby/classes/Vpi/Handle.src/M000089.html +9 -74
  101. data/ref/ruby/classes/Vpi/Handle.src/M000090.html +31 -17
  102. data/ref/ruby/classes/Vpi/Handle.src/M000091.html +74 -11
  103. data/ref/ruby/classes/Vpi/Handle.src/M000092.html +30 -0
  104. data/ref/ruby/classes/Vpi/Handle.src/M000093.html +11 -55
  105. data/ref/ruby/classes/Vpi/Handle.src/M000095.html +68 -0
  106. data/ref/ruby/classes/Vpi/Handle/Property.html +5 -5
  107. data/ref/ruby/classes/Vpi/Handle/Property.src/{M000094.html → M000096.html} +0 -0
  108. data/ref/ruby/classes/XX/Document.html +45 -45
  109. data/ref/ruby/classes/XX/Document.src/M000074.html +9 -7
  110. data/ref/ruby/classes/XX/Document.src/M000075.html +7 -7
  111. data/ref/ruby/classes/XX/Document.src/M000076.html +7 -9
  112. data/ref/ruby/classes/XX/Document.src/M000077.html +7 -8
  113. data/ref/ruby/classes/XX/Document.src/M000078.html +9 -8
  114. data/ref/ruby/classes/XX/Document.src/M000079.html +8 -21
  115. data/ref/ruby/classes/XX/Document.src/M000080.html +8 -85
  116. data/ref/ruby/classes/XX/Document.src/M000081.html +34 -0
  117. data/ref/ruby/classes/XX/Document.src/M000082.html +98 -0
  118. data/ref/ruby/classes/XX/HTML4.html +5 -5
  119. data/ref/ruby/classes/XX/HTML4.src/{M000036.html → M000038.html} +0 -0
  120. data/ref/ruby/classes/XX/HTML4/Strict.html +5 -5
  121. data/ref/ruby/classes/XX/HTML4/Strict.src/{M000038.html → M000040.html} +0 -0
  122. data/ref/ruby/classes/XX/HTML4/Transitional.html +5 -5
  123. data/ref/ruby/classes/XX/HTML4/Transitional.src/{M000037.html → M000039.html} +0 -0
  124. data/ref/ruby/classes/XX/Markup.html +5 -5
  125. data/ref/ruby/classes/XX/Markup.src/{M000043.html → M000045.html} +0 -0
  126. data/ref/ruby/classes/XX/Markup/ClassMethods.html +40 -40
  127. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000046.html +9 -12
  128. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000047.html +7 -7
  129. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000048.html +12 -14
  130. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000049.html +7 -7
  131. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000050.html +14 -14
  132. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000051.html +7 -9
  133. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000052.html +27 -0
  134. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000053.html +22 -0
  135. data/ref/ruby/classes/XX/Markup/InstanceMethods.html +100 -100
  136. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000054.html +43 -18
  137. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000055.html +20 -35
  138. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000056.html +18 -7
  139. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000057.html +35 -18
  140. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000058.html +7 -19
  141. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000059.html +18 -19
  142. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000060.html +19 -15
  143. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000061.html +19 -10
  144. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000062.html +15 -13
  145. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000063.html +10 -7
  146. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000064.html +13 -7
  147. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000065.html +7 -7
  148. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000066.html +7 -7
  149. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000067.html +7 -7
  150. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000068.html +7 -8
  151. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000069.html +7 -7
  152. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000070.html +8 -7
  153. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000071.html +7 -7
  154. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000072.html +20 -0
  155. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000073.html +20 -0
  156. data/ref/ruby/classes/XX/XHTML.html +5 -5
  157. data/ref/ruby/classes/XX/XHTML.src/{M000039.html → M000041.html} +0 -0
  158. data/ref/ruby/classes/XX/XHTML/Strict.html +5 -5
  159. data/ref/ruby/classes/XX/XHTML/Strict.src/{M000041.html → M000043.html} +0 -0
  160. data/ref/ruby/classes/XX/XHTML/Transitional.html +5 -5
  161. data/ref/ruby/classes/XX/XHTML/Transitional.src/{M000040.html → M000042.html} +0 -0
  162. data/ref/ruby/classes/XX/XML.html +5 -5
  163. data/ref/ruby/classes/XX/XML.src/{M000035.html → M000037.html} +0 -0
  164. data/ref/ruby/classes/XX/XMLish.html +5 -5
  165. data/ref/ruby/classes/XX/XMLish.src/{M000042.html → M000044.html} +0 -0
  166. data/ref/ruby/created.rid +1 -1
  167. data/ref/ruby/files/lib/ruby-vpi/float_rb.html +101 -0
  168. data/ref/ruby/files/lib/ruby-vpi/rspec_rb.html +1 -1
  169. data/ref/ruby/files/lib/ruby-vpi/runner_rb.html +1 -1
  170. data/ref/ruby/files/lib/ruby-vpi/verilog_parser_rb.html +1 -1
  171. data/ref/ruby/fr_class_index.html +1 -0
  172. data/ref/ruby/fr_file_index.html +1 -0
  173. data/ref/ruby/fr_method_index.html +69 -67
  174. data/samp/counter/counter.v +4 -4
  175. data/samp/counter/counter_rspec_spec.rb +4 -8
  176. data/samp/counter/counter_xunit_spec.rb +4 -8
  177. metadata +112 -196
  178. data/HEADER +0 -97
  179. data/HISTORY +0 -687
  180. data/README +0 -23
  181. data/doc/background.html +0 -3
  182. data/doc/background.methodology.html +0 -3
  183. data/doc/background.organization.html +0 -10
  184. data/doc/background.running-tests.html +0 -3
  185. data/doc/background.terminology.html +0 -3
  186. data/doc/gfdl-0.html +0 -18
  187. data/doc/gfdl-1.html +0 -70
  188. data/doc/gfdl-10.html +0 -15
  189. data/doc/gfdl-2.html +0 -13
  190. data/doc/gfdl-3.html +0 -31
  191. data/doc/gfdl-4.html +0 -75
  192. data/doc/gfdl-5.html +0 -20
  193. data/doc/gfdl-6.html +0 -12
  194. data/doc/gfdl-7.html +0 -16
  195. data/doc/gfdl-8.html +0 -17
  196. data/doc/gfdl-9.html +0 -9
  197. data/doc/gfdl-addendum.html +0 -25
  198. data/doc/gfdl.html +0 -11
  199. data/doc/glossary.html +0 -3
  200. data/doc/hacking.html +0 -3
  201. data/doc/hacking.release-packages.html +0 -7
  202. data/doc/images/ChangeLog +0 -27
  203. data/doc/images/blank.png +0 -0
  204. data/doc/images/callouts/1.png +0 -0
  205. data/doc/images/callouts/10.png +0 -0
  206. data/doc/images/callouts/11.png +0 -0
  207. data/doc/images/callouts/12.png +0 -0
  208. data/doc/images/callouts/13.png +0 -0
  209. data/doc/images/callouts/14.png +0 -0
  210. data/doc/images/callouts/15.png +0 -0
  211. data/doc/images/callouts/2.png +0 -0
  212. data/doc/images/callouts/3.png +0 -0
  213. data/doc/images/callouts/4.png +0 -0
  214. data/doc/images/callouts/5.png +0 -0
  215. data/doc/images/callouts/6.png +0 -0
  216. data/doc/images/callouts/7.png +0 -0
  217. data/doc/images/callouts/8.png +0 -0
  218. data/doc/images/callouts/9.png +0 -0
  219. data/doc/images/callouts/ChangeLog +0 -15
  220. data/doc/images/copyright +0 -55
  221. data/doc/images/draft.png +0 -0
  222. data/doc/images/toc-blank.png +0 -0
  223. data/doc/images/toc-minus.png +0 -0
  224. data/doc/images/toc-plus.png +0 -0
  225. data/doc/index.html +0 -4
  226. data/doc/introduction.html +0 -3
  227. data/doc/introduction.license.html +0 -3
  228. data/doc/introduction.manifest.html +0 -3
  229. data/doc/introduction.related-works.html +0 -3
  230. data/doc/introduction.resources.html +0 -3
  231. data/doc/manual.txt +0 -1852
  232. data/doc/problem.ivl.html +0 -18
  233. data/doc/problems.html +0 -3
  234. data/doc/problems.ruby.html +0 -3
  235. data/doc/problems.vsim.html +0 -3
  236. data/doc/setup.html +0 -3
  237. data/doc/setup.installation.html +0 -9
  238. data/doc/setup.maintenance.html +0 -3
  239. data/doc/setup.reqs.html +0 -3
  240. data/doc/src/figures.dia +0 -0
  241. data/doc/src/license.xml +0 -446
  242. data/doc/src/manual.xml +0 -1824
  243. data/doc/src/manual.xsl +0 -23
  244. data/doc/src/shared.dtd +0 -62
  245. data/doc/styles/manual.css +0 -91
  246. data/doc/usage.examples.html +0 -3
  247. data/doc/usage.html +0 -3
  248. data/doc/usage.tools.html +0 -9
  249. data/doc/usage.tutorial.html +0 -189
  250. data/header.html +0 -95
  251. data/header.part.html +0 -95
  252. data/history.html +0 -1442
  253. data/history.part.html +0 -1346
  254. data/memo.html +0 -211
  255. data/readme.html +0 -138
  256. data/readme.part.html +0 -42
  257. data/ref/c/globals_0x62.html +0 -62
  258. data/ref/c/globals_0x67.html +0 -64
  259. data/ref/c/globals_0x69.html +0 -62
  260. data/ref/c/globals_0x6c.html +0 -64
  261. data/ref/c/globals_0x6d.html +0 -62
  262. data/ref/c/globals_0x6e.html +0 -63
  263. data/ref/c/globals_0x75.html +0 -63
  264. data/ref/c/globals_defs_0x6c.html +0 -57
  265. data/ref/c/globals_defs_0x6e.html +0 -56
  266. data/ref/c/globals_defs_0x72.html +0 -57
  267. data/ref/c/globals_defs_0x73.html +0 -164
  268. data/ref/c/globals_defs_0x75.html +0 -56
  269. data/ref/c/globals_func_0x66.html +0 -62
  270. data/ref/c/globals_func_0x67.html +0 -55
  271. data/ref/c/globals_func_0x69.html +0 -53
  272. data/ref/c/globals_func_0x70.html +0 -53
  273. data/ref/c/globals_func_0x72.html +0 -57
  274. data/ref/c/globals_func_0x73.html +0 -114
  275. data/ref/c/globals_func_0x76.html +0 -57
  276. data/ref/c/structswig__cast__info.html +0 -98
  277. data/ref/c/structswig__class.html +0 -115
  278. data/ref/c/structswig__module__info.html +0 -132
  279. data/ref/c/structswig__type__info.html +0 -132
  280. data/ref/c/swig__vpi_8h.html +0 -8739
  281. data/ref/c/swig__wrap_8cin.html +0 -11556
  282. data/ref/c/unions__vpi__value__value.html +0 -166
  283. data/ref/ruby/classes/String.src/M000032.html +0 -41
  284. data/ref/ruby/classes/Vpi/Handle.src/M000085.html +0 -18
  285. data/ref/ruby/classes/Vpi/Handle.src/M000086.html +0 -18
  286. data/ref/ruby/classes/XX/Document.src/M000072.html +0 -22
  287. data/ref/ruby/classes/XX/Document.src/M000073.html +0 -20
  288. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000044.html +0 -22
  289. data/ref/ruby/classes/XX/Markup/ClassMethods.src/M000045.html +0 -20
  290. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000052.html +0 -56
  291. data/ref/ruby/classes/XX/Markup/InstanceMethods.src/M000053.html +0 -33
  292. data/style.css +0 -47
data/README DELETED
@@ -1,23 +0,0 @@
1
- h1{text-align: center}. Welcome to Ruby-VPI
2
-
3
- Ruby-VPI is a "Ruby interface":http://ruby-lang.org to "Verilog VPI":http://ieeexplore.ieee.org/xpl/standardstoc.jsp?isnumber=33945. It lets you create complex Verilog test benches easily and wholly in Ruby.
4
-
5
- h2. Features
6
-
7
- * Prototype and verify designs _quickly_ using "BDD(behavior-driven development)":http://behaviour-driven.org/, "TDD(test-driven development)":http://www.agiledata.org/essays/tdd.html, and more.
8
- * Reuse the _same_ specification to verify both prototype and design.
9
- * Specifications are executable _and_ human-readable. (See this <a href="./doc/usage.tutorial.html#fig..counter_rspec_spec.rb">example specification</a> and its <a href="./doc/usage.tutorial.html#fig..test-proto.rspec">boss-friendly output</a>.)
10
-
11
- * Utilize Ruby's power and elegance. ("Why choose Ruby?":http://www.ruby-doc.org/whyruby)
12
- ** Built-in support for unlimited length integers, regular expressions, networking, multi-threading, system calls, _ad infinium_!
13
- ** Easy to use; doesn't get in your way.
14
- ** Makes programming _fun_ again!
15
-
16
- * Study, modify, or distribute this free software in accordance with the "GNU General Public License":http://www.gnu.org/copyleft/gpl.html.
17
-
18
-
19
- h1. Release notes
20
-
21
- * See the "release history":./history.html to see what is new in this release.
22
-
23
- * See the "project memo":./memo.html for a list of pending tasks.
data/doc/background.html DELETED
@@ -1,3 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 2. Background</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="index.html" title="Ruby-VPI user manual" /><link rel="prev" href="introduction.related-works.html" title="Related works" /><link rel="next" href="background.methodology.html" title="Methodology" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 2. Background</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="introduction.related-works.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="background.methodology.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="background"></a>Chapter 2. Background</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="background.methodology.html">Methodology</a></span></dt><dt><span class="section"><a href="background.terminology.html">Terminology</a></span></dt><dt><span class="section"><a href="background.organization.html">Organization</a></span></dt><dd><dl><dt><span class="section"><a href="background.organization.html#organization.vpi">Interface to <span class="acronym">VPI</span></a></span></dt></dl></dd><dt><span class="section"><a href="background.running-tests.html">Running a test</a></span></dt><dd><dl><dt><span class="section"><a href="background.running-tests.html#background.running-tests.init">Initialization</a></span></dt><dt><span class="section"><a href="background.running-tests.html#background.running-tests.exec">Execution</a></span></dt></dl></dd></dl></div><p><span class="application">Ruby-VPI</span> is a <a href="glossary.html#term..bench">Bench</a> which lets you <a href="glossary.html#term..test">Test</a> Verilog modules using the Ruby language.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="introduction.related-works.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="background.methodology.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Related works </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Methodology</td></tr></table></div></body></html>
data/doc/background.methodology.html DELETED
@@ -1,3 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Methodology</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="background.html" title="Chapter 2. Background" /><link rel="prev" href="background.html" title="Chapter 2. Background" /><link rel="next" href="background.terminology.html" title="Terminology" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Methodology</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="background.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 2. Background</th><td width="20%" align="right"> <a accesskey="n" href="background.terminology.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="background.methodology"></a>Methodology</h2></div></div></div><p><span class="application">Ruby-VPI</span> presents an open-ended interface to <span class="acronym">VPI</span>. Thus, you can use any methodology you wish when writing tests. However, <a href="glossary.html#term..BDD"><span class="acronym">BDD</span></a> is emphasized in this project because it greatly simplifies thinking about <span class="emphasis"><em>how</em></span> to verify a design.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="background.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="background.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="background.terminology.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 2. Background </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Terminology</td></tr></table></div></body></html>
data/doc/background.organization.html DELETED
@@ -1,10 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Organization</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="background.html" title="Chapter 2. Background" /><link rel="prev" href="background.terminology.html" title="Terminology" /><link rel="next" href="background.running-tests.html" title="Running a test" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Organization</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="background.terminology.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 2. Background</th><td width="20%" align="right"> <a accesskey="n" href="background.running-tests.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="background.organization"></a>Organization</h2></div></div></div><div class="figure"><a id="fig..organization"></a><p class="title"><b>Figure 2.1. Overall organization of a test</b></p><div class="mediaobject"><img src="figures/organization.png" alt="Overall organization of a test" /></div></div><p>As <a href="background.organization.html#fig..organization" title="Figure 2.1. Overall organization of a test">Figure 2.1, “Overall organization of a test”</a> shows, a test is composed of a bench, a design, and a specification. To extend the <a href="background.terminology.html" title="Terminology">analogy of an electronics laboratory</a>, the first acts as the laboratory bench which provides measurement and manipulation tools. The second acts as the electronic component being verified by the engineer. And the third acts as the engineer who measures, manipulates, and verifies the electronic component.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="organization.vpi"></a>Interface to <span class="acronym">VPI</span></h3></div></div></div><div class="figure"><a id="fig..organization.detail"></a><p class="title"><b>Figure 2.2. Detailed organization of a test</b></p><div class="mediaobject"><img src="figures/organization_detailed.png" alt="Detailed organization of a test" /></div></div><p>In <a href="background.organization.html#fig..organization.detail" title="Figure 2.2. Detailed organization of a test">Figure 2.2, “Detailed organization of a test”</a>, <span class="application">Ruby-VPI</span> acts as the bench, a Verilog simulator encapsulates the design, and a Ruby interpreter encapsulates the specification. Notice that <span class="application">Ruby-VPI</span> encapsulates all communication between the Ruby interpreter and <span class="acronym">VPI</span>. This allows the specification, or any Ruby program in general, to access <span class="acronym">VPI</span> using nothing more than the Ruby language! Thus, <span class="application">Ruby-VPI</span> removes the burden of having to write C programs in order to access <span class="acronym">VPI</span>.</p><p>Furthermore, <span class="application">Ruby-VPI</span> presents the <span class="emphasis"><em>entire</em></span> IEEE Std 1364-2005 <span class="acronym">VPI</span> interface to the Ruby interpreter, but with the following minor changes.
4
-
5
- </p><div class="itemizedlist"><ul type="disc"><li><p>The first letter in the name of every function, type, structure, and constant becomes capitalized.</p><p>For example, the <span class="type">s_vpi_value</span> structure in C becomes the <span class="type">S_vpi_value</span> class in Ruby. Likewise, the <code class="constant">vpiIntVal</code> constant in C becomes the <code class="constant">VpiIntVal</code> constant in Ruby.</p></li><li><p>The <span class="acronym">VPI</span> functions <code class="function">vpi_vprintf</code> and <code class="function">vpi_mcd_vprintf</code> are not made accessible to Ruby. However, this isn't a big problem because you can use Ruby's <code class="function">printf</code> method instead.</p><p>The reason for this limitation is that some C compilers have trouble with pointers to the <span class="type">va_list</span> type. For these compilers, the second line in the code shown below causes a “<span class="quote">type mismatch</span>” error.</p><pre class="programlisting">
6
- <span class="type">void</span> <code class="function">foo</code>(<em class="parameter"><code><span class="type">va_list</span> <code class="varname">ap</code></code></em>) {
7
- <span class="type">va_list</span> *<code class="varname">p</code> = &amp;<code class="varname">ap</code>;
8
- }
9
- </pre></li></ul></div><p>
10
- </p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="organization.vpi.util"></a><span class="acronym">VPI</span> utility layer</h4></div></div></div><p>From a user's perspective, the <span class="acronym">VPI</span> utility layer greatly enhances the ability to interact with handles. One simply invokes a handle's methods, which are carefully named in the following manner, to access either (1) its children or (2) its <span class="acronym">VPI</span> properties.</p><p>The children of a handle are simply the handles that are immediately contained within it in. For example, suppose that you had a Verilog module that contains some registers. The children, of a handle to the module, would be handles to the registers.</p><p>In the event that a child handle has the same name as a <span class="acronym">VPI</span> property, the child is given priority. However, you can always access <span class="acronym">VPI</span> properties explicitly via the <code class="function">get_value</code> and <code class="function">put_value</code> methods.</p><div class="table"><a id="table..handle-property-accessor-naming-format"></a><p class="title"><b>Table 2.1. Naming format for accessing a handle's <span class="acronym">VPI</span> properties</b></p><table summary="Naming format for accessing a handle's VPI properties" border="1"><colgroup><col /><col /><col /><col /><col /><col /></colgroup><thead><tr><th>Operation</th><th>_</th><th>Property</th><th>_</th><th>Accessor</th><th>Addendum</th></tr></thead><tbody><tr><td colspan="2">optional</td><td>required</td><td colspan="2">optional</td><td>optional</td></tr></tbody></table></div><div class="variablelist"><dl><dt><span class="term">Operation</span></dt><dd><p>This parameter suggests a method that should be invoked in the context of the Property parameter.</p></dd><dt><span class="term">Property</span></dt><dd><p>This parameter suggests which <span class="acronym">VPI</span> property should be accessed. The first letter of this parameter's value should be lower case, and the <span class="emphasis"><em>vpi</em></span> prefix—common to all <span class="acronym">VPI</span> properties—can be omitted.</p><p>For example, the <span class="acronym">VPI</span> property <span class="emphasis"><em>vpiFullName</em></span> is considered equivalent to <span class="emphasis"><em>fullName</em></span> but not equivalent to either <span class="emphasis"><em>FullName</em></span> or <span class="emphasis"><em>full_name</em></span>.</p></dd><dt><span class="term">Accessor</span></dt><dd><p>This parameter suggests which <span class="acronym">VPI</span> function should be used to access the <span class="acronym">VPI</span> property. When this parameter is not specified, the <span class="acronym">VPI</span> utility layer will attempt to <span class="emphasis"><em>guess</em></span> the value of this parameter (<a href="../ref/ruby/classes/Vpi/Handle/Property.html" target="_top">see the source code</a> of the <code class="code"><code class="constant">Property</code>.<code class="function">resolve</code></code> method for details).</p><div class="table"><a id="id2488103"></a><p class="title"><b>Table 2.2. Possible accessors and their implications</b></p><table summary="Possible accessors and their implications" border="1"><colgroup></colgroup><thead><tr><th>Accessor</th><th>Kind of value accessed</th><th><span class="acronym">VPI</span> functions used to access the value</th></tr></thead><tbody><tr><td>d</td><td>delay</td><td><code class="function">vpi_get_delays</code>, <code class="function">vpi_put_delays</code></td></tr><tr><td>l</td><td>logic</td><td><code class="function">vpi_get_value</code>, <code class="function">vpi_put_value</code></td></tr><tr><td>i</td><td>integer</td><td><code class="function">vpi_get</code></td></tr><tr><td>b</td><td>boolean</td><td><code class="function">vpi_get</code></td></tr><tr><td>s</td><td>string</td><td><code class="function">vpi_get_str</code></td></tr><tr><td>h</td><td>handle</td><td><code class="function">vpi_handle</code></td></tr></tbody></table></div></dd><dt><span class="term">Addendum</span></dt><dd><p>When this parameter is a question mark (<span class="emphasis"><em>?</em></span>), it suggests that the specified <span class="acronym">VPI</span> property should be queried as a boolean value. This produces the same effect as specifying <span class="emphasis"><em>b</em></span> for the Accessor parameter.</p><p>When this parameter is an equal sign (<span class="emphasis"><em>=</em></span>), it suggests that the specified <span class="acronym">VPI</span> property should be written to.</p></dd></dl></div><div class="example"><a id="ex..handle-property-accessor-naming-format"></a><p class="title"><b>Example 2.1. Accessing a handle's <span class="acronym">VPI</span> properties</b></p><div class="informaltable"><table border="1"><colgroup><col /><col /><col /><col /><col /><col /></colgroup><thead><tr><th rowspan="2">Ruby expression</th><th colspan="6">Naming format</th><th rowspan="2">Description</th></tr><tr><th>Operation</th><th>_</th><th>Property</th><th>_</th><th>Accessor</th><th>Addendum</th></tr></thead><tbody><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">each_vpiNet</code> {|<code class="varname">net</code>| <code class="function">puts</code> <code class="varname">net</code>.<code class="function">fullName</code>}</code></td><td>each</td><td>_</td><td>vpiNet</td><td> </td><td> </td><td> </td><td rowspan="2">These expressions print the full name of each <code class="constant">vpiNet</code> object associated with the handle.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">each_net</code> {|<code class="varname">net</code>| <code class="function">puts</code> <code class="varname">net</code>.<code class="function">fullName</code>}</code></td><td>each</td><td>_</td><td>net</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">all_reg?</code> {|<code class="varname">reg</code>| <code class="varname">reg</code>.<code class="function">size</code> == <code class="literal">1</code>}</code></td><td>all?</td><td>_</td><td>vpiReg</td><td> </td><td> </td><td> </td><td rowspan="2">These expressions check if all registers associated with the handle are capable of storing only one bit.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">all_reg?</code> {|<code class="varname">reg</code>| <code class="varname">reg</code>.<code class="function">size</code> == <code class="literal">1</code>}</code></td><td>all?</td><td>_</td><td>reg</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">select_vpiNet</code> {|<code class="varname">net</code>| <code class="varname">net</code>.<code class="function">x?</code>}</code></td><td>select</td><td>_</td><td>vpiReg</td><td> </td><td> </td><td> </td><td rowspan="5">These expressions return a list of nets whose logic value is “<span class="quote">don't care</span>”.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">select_net</code> {|<code class="varname">net</code>| <code class="varname">net</code>.<code class="function">x?</code>}</code></td><td>select</td><td>_</td><td>net</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">select</code>(<code class="constant">VpiNet</code>) {|<code class="varname">net</code>| <code class="varname">net</code>.<code class="function">x?</code>}</code></td><td>select</td><td>_</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">select</code>(<code class="literal">:VpiNet</code>) {|<code class="varname">net</code>| <code class="varname">net</code>.<code class="function">x?</code>}</code></td><td>select</td><td>_</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">select</code>(<code class="literal">:net</code>) {|<code class="varname">net</code>| <code class="varname">net</code>.<code class="function">x?</code>}</code></td><td>select</td><td>_</td><td> </td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiIntVal</code></code></td><td> </td><td> </td><td>vpiIntVal</td><td> </td><td> </td><td> </td><td rowspan="4">These expressions access the logic value of the handle's <code class="constant">vpiIntVal</code> property.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiIntVal_l</code></code></td><td> </td><td> </td><td>vpiIntVal</td><td>_</td><td>l</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">intVal</code></code></td><td> </td><td> </td><td>intVal</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">intVal_l</code></code></td><td> </td><td> </td><td>intVal</td><td>_</td><td>l</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiIntVal</code> = <code class="literal">15</code></code></td><td> </td><td> </td><td>vpiIntVal</td><td> </td><td> </td><td>=</td><td rowspan="4">These expressions assign the number 15 to the logic value of the handle's <code class="constant">vpiIntVal</code> property.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiIntVal_l</code> = <code class="literal">15</code></code></td><td> </td><td> </td><td>vpiIntVal</td><td>_</td><td>l</td><td>=</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">intVal</code> = <code class="literal">15</code></code></td><td> </td><td> </td><td>intVal</td><td> </td><td> </td><td>=</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">intVal</code>_l = <code class="literal">15</code></code></td><td> </td><td> </td><td>intVal</td><td>_</td><td>l</td><td>=</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiType</code></code></td><td> </td><td> </td><td>vpiType</td><td> </td><td> </td><td> </td><td rowspan="4">These expressions access the integer value of the handle's <code class="constant">vpiType</code> property.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiType_i</code></code></td><td> </td><td> </td><td>vpiType</td><td>_</td><td>i</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">type</code></code></td><td> </td><td> </td><td>type</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">type_i</code></code></td><td> </td><td> </td><td>type</td><td>_</td><td>i</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiProtected</code></code></td><td> </td><td> </td><td>vpiProtected</td><td> </td><td> </td><td> </td><td rowspan="6">These expressions access the boolean value of the handle's <code class="constant">vpiProtected</code> property.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiProtected_b</code></code></td><td> </td><td> </td><td>vpiProtected</td><td>_</td><td>b</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiProtected?</code></code></td><td> </td><td> </td><td>vpiProtected</td><td> </td><td> </td><td>?</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">protected</code></code></td><td> </td><td> </td><td>protected</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">protected_b</code></code></td><td> </td><td> </td><td>protected</td><td>_</td><td>b</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">protected?</code></code></td><td> </td><td> </td><td>protected</td><td> </td><td> </td><td>?</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiFullName</code></code></td><td> </td><td> </td><td>vpiFullName</td><td> </td><td> </td><td> </td><td rowspan="4">These expressions access the string value of the handle's <code class="constant">vpiFullName</code> property.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiFullName_s</code></code></td><td> </td><td> </td><td>vpiFullName</td><td>_</td><td>s</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">fullName</code></code></td><td> </td><td> </td><td>fullName</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">fullName_s</code></code></td><td> </td><td> </td><td>fullName</td><td>_</td><td>s</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiParent</code></code></td><td> </td><td> </td><td>vpiParent</td><td> </td><td> </td><td> </td><td rowspan="4">These expressions access the handle value of the handle's <code class="constant">vpiParent</code> property.</td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">vpiParent_h</code></code></td><td> </td><td> </td><td>vpiParent</td><td>_</td><td>h</td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">parent</code></code></td><td> </td><td> </td><td>parent</td><td> </td><td> </td><td> </td></tr><tr><td><code class="code"><code class="varname">handle</code>.<code class="function">parent_h</code></code></td><td> </td><td> </td><td>parent</td><td>_</td><td>h</td><td> </td></tr></tbody></table></div></div></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="background.terminology.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="background.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="background.running-tests.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Terminology </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Running a test</td></tr></table></div></body></html>
data/doc/background.running-tests.html DELETED
@@ -1,3 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Running a test</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="background.html" title="Chapter 2. Background" /><link rel="prev" href="background.organization.html" title="Organization" /><link rel="next" href="setup.html" title="Chapter 3. Setup" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Running a test</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="background.organization.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 2. Background</th><td width="20%" align="right"> <a accesskey="n" href="setup.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="background.running-tests"></a>Running a test</h2></div></div></div><p>Unlike an engineer who can verify an electronic component in real-time, the Verilog simulator and the Ruby interpreter (see <a href="background.organization.html#fig..organization.detail" title="Figure 2.2. Detailed organization of a test">Figure 2.2, “Detailed organization of a test”</a>) take turns working with objects in a simulation when a test is run. In particular, they take turns manipulating the design and transfer control to each other when appropriate.</p><p>The situation is similar to a pair of friends playing catch. One friend throws a ball to the other, and the other throws it back. Either is able to inspect and modify the ball, but only when it is in hand.</p><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="background.running-tests.init"></a>Initialization</h3></div></div></div><p>A test is first initialized before it is <a href="background.running-tests.html#background.running-tests.exec" title="Execution">executed</a>. <a href="background.running-tests.html#fig..ruby_init" title="Figure 2.3. Initialization of a test">Figure 2.3, “Initialization of a test”</a> illustrates the initialization process <a href="background.running-tests.html#proc..ruby_init">described below</a>.</p><div class="figure"><a id="fig..ruby_init"></a><p class="title"><b>Figure 2.3. Initialization of a test</b></p><div class="mediaobject"><img src="figures/ruby_init.png" alt="Initialization of a test" /></div></div><div class="procedure"><a id="proc..ruby_init"></a><p class="title"><b>Procedure 2.1. Initialization of a test</b></p><ol type="1"><li><p>The Verilog simulator initializes the Ruby interpreter by invoking the <code class="code"><code class="function">$ruby_init</code>;</code> system task/function, whose parameters represent the command-line invocation of the Ruby interpreter. For example, one would specify <code class="code"><code class="function">$ruby_init</code>(<em class="parameter"><code><code class="literal">"ruby"</code></code></em>, <em class="parameter"><code><code class="literal">"-w"</code></code></em>);</code> in Verilog to achieve the same effect as specifying <span><strong class="command">ruby <code class="option">-w</code></strong></span> at a command-prompt.</p></li><li><p>The Verilog simulator is paused and the Ruby interpreter is initialized with the arguments of the <code class="code"><code class="function">$ruby_init</code>;</code> system task/function.</p></li><li><p>When the Ruby interpreter invokes the <code class="code"><code class="constant">Vpi</code>::<code class="function">relay_verilog</code></code> method, it is paused and the Verilog simulator is given control.</p></li></ol></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="background.running-tests.exec"></a>Execution</h3></div></div></div><p>After a test is <a href="background.running-tests.html#background.running-tests.init" title="Initialization">initialized</a>, it is executed such that the design is verified against the specification. <a href="background.running-tests.html#fig..ruby_relay" title="Figure 2.4. Execution of a test">Figure 2.4, “Execution of a test”</a> illustrates the execution process <a href="background.running-tests.html#proc..ruby_relay">described below</a>.</p><div class="figure"><a id="fig..ruby_relay"></a><p class="title"><b>Figure 2.4. Execution of a test</b></p><div class="mediaobject"><img src="figures/ruby_relay.png" alt="Execution of a test" /></div></div><div class="procedure"><a id="proc..ruby_relay"></a><p class="title"><b>Procedure 2.2. Execution of a test</b></p><ol type="1"><li><p>The Verilog simulator transfers control to the Ruby interpreter by invoking the <code class="code"><code class="function">$ruby_relay</code>;</code> system task/function.</p></li><li><p>The Verilog simulator is paused and the Ruby interpreter is given control.</p></li><li><p>When the Ruby interpreter invokes the <code class="code"><code class="constant">Vpi</code>::<code class="function">relay_verilog</code></code> method, it is paused and the Verilog simulator is given control.</p></li></ol></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="background.organization.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="background.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="setup.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Organization </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Chapter 3. Setup</td></tr></table></div></body></html>
data/doc/background.terminology.html DELETED
@@ -1,3 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Terminology</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="background.html" title="Chapter 2. Background" /><link rel="prev" href="background.methodology.html" title="Methodology" /><link rel="next" href="background.organization.html" title="Organization" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Terminology</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="background.methodology.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 2. Background</th><td width="20%" align="right"> <a accesskey="n" href="background.organization.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="background.terminology"></a>Terminology</h2></div></div></div><div class="tip" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Tip"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Tip]" src="images/tip.png" /></td><th align="left">Tip</th></tr><tr><td align="left" valign="top"><p>Have a look at the <a href="glossary.html" title="Glossary">Glossary</a> for definitions of terms used in this manual.</p></td></tr></table></div><p>As a newcomer into the world of Verilog, I often heard the term <span class="emphasis"><em>test bench</em></span>: “<span class="quote">I ran the test bench, but it didn't work!</span>” or “<span class="quote">Are you crazy?!! You <span class="emphasis"><em>still</em></span> haven't written the test bench? o_O</span>”, for example. I flipped through my textbook and surfed the Internet for a definition of the term, but it was to no avail. Instead, both resources nonchalantly employed the term <span class="emphasis"><em>throughout</em></span> their being, as if mocking my ignorance of what seems to be universal knowledge.</p><p>Defeated, I turned to my inner faculties to determine the answer. “<span class="quote">Let's see, the term <span class="emphasis"><em>test bench</em></span> has the word <span class="emphasis"><em>test</em></span>—so it has something to do with testing—and it has the word <span class="emphasis"><em>bench</em></span>—so maybe it's referring to a table where the testing should occur</span>”. This reasoning grew increasingly familiar as my mind rummaged through towering stores of obsolescence and ultimately revealed dreaded memories of sleepless anguish: debugging electronics in the robotics laboratory.</p><p>“<span class="quote">Aha!</span>”, I exclaimed hesitantly, trying to dismiss the past. The term has its roots in the testing of electronic devices, where an engineer would sit at a bench in an electronics laboratory and verify that an electronic component satisfies some criteria. The bench would be furnished with tools of measurement and manipulation—such as oscilloscopes, voltmeters, soldering irons, and so on—which help the engineer to verify the electronic component or locate the sources of defects in the component.</p><p>Alright, now I remember what a laboratory bench is, but how does that compare with the term test bench? Surely they cannot have the same meaning, because it doesn't make sense to <span class="emphasis"><em>run</em></span> a laboratory bench or to <span class="emphasis"><em>write</em></span> one. Thus, to avoid propagating such confusion into this manual, I have attempted to clarify the terminology by <a href="glossary.html" title="Glossary">simplifying and reintroducing it in a new light</a>.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="background.methodology.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="background.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="background.organization.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Methodology </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Organization</td></tr></table></div></body></html>
data/doc/gfdl-0.html DELETED
@@ -1,18 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>PREAMBLE</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="next" href="gfdl-1.html" title="APPLICABILITY AND DEFINITIONS" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">PREAMBLE</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-1.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-0"></a>PREAMBLE</h2></div></div></div><p>The purpose of this License is to make a manual, textbook, or
4
- other functional and useful document "free" in the sense of freedom: to
5
- assure everyone the effective freedom to copy and redistribute it, with
6
- or without modifying it, either commercially or noncommercially.
7
- Secondarily, this License preserves for the author and publisher a way
8
- to get credit for their work, while not being considered responsible for
9
- modifications made by others.</p><p>This License is a kind of "copyleft", which means that derivative
10
- works of the document must themselves be free in the same sense. It
11
- complements the GNU General Public License, which is a copyleft license
12
- designed for free software.</p><p>We have designed this License in order to use it for manuals for
13
- free software, because free software needs free documentation: a free
14
- program should come with manuals providing the same freedoms that the
15
- software does. But this License is not limited to software manuals; it
16
- can be used for any textual work, regardless of subject matter or
17
- whether it is published as a printed book. We recommend this License
18
- principally for works whose purpose is instruction or reference.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-1.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Appendix A. GNU Free Documentation License </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> APPLICABILITY AND DEFINITIONS</td></tr></table></div></body></html>
data/doc/gfdl-1.html DELETED
@@ -1,70 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>APPLICABILITY AND DEFINITIONS</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-0.html" title="PREAMBLE" /><link rel="next" href="gfdl-2.html" title="VERBATIM COPYING" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">APPLICABILITY AND DEFINITIONS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-0.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-2.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-1"></a>APPLICABILITY AND DEFINITIONS</h2></div></div></div><p><a id="gfdl-doc"></a>This License applies to any manual or other work, in
4
- any medium, that contains a notice placed by the copyright holder saying
5
- it can be distributed under the terms of this License. Such a notice
6
- grants a world-wide, royalty-free license, unlimited in duration, to use
7
- that work under the conditions stated herein. The "Document", below,
8
- refers to any such manual or work. Any member of the public is a
9
- licensee, and is addressed as "you". You accept the license if you
10
- copy, modify or distribute the work in a way requiring permission under
11
- copyright law.</p><p><a id="gfdl-mod-ver"></a>A "Modified Version" of the Document means any
12
- work containing the Document or a portion of it, either copied verbatim,
13
- or with modifications and/or translated into another language.</p><p><a id="gfdl-secnd-sect"></a>A "Secondary Section" is a named appendix or
14
- a front-matter section of the Document that deals exclusively with the
15
- relationship of the publishers or authors of the Document to the
16
- Document's overall subject (or to related matters) and contains nothing
17
- that could fall directly within that overall subject. (Thus, if the
18
- Document is in part a textbook of mathematics, a Secondary Section may
19
- not explain any mathematics.) The relationship could be a matter of
20
- historical connection with the subject or with related matters, or of
21
- legal, commercial, philosophical, ethical or political position
22
- regarding them.</p><p><a id="gfdl-inv-sect"></a>The "Invariant Sections" are certain Secondary
23
- Sections whose titles are designated, as being those of Invariant
24
- Sections, in the notice that says that the Document is released under
25
- this License. If a section does not fit the above definition of
26
- Secondary then it is not allowed to be designated as Invariant. The
27
- Document may contain zero Invariant Sections. If the Document does not
28
- identify any Invariant Sections then there are none.</p><p><a id="gfdl-cov-text"></a>The "Cover Texts" are certain short passages of
29
- text that are listed, as Front-Cover Texts or Back-Cover Texts, in the
30
- notice that says that the Document is released under this License. A
31
- Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at
32
- most 25 words.</p><p><a id="gfdl-transparent"></a>A "Transparent" copy of the Document means a
33
- machine-readable copy, represented in a format whose specification is
34
- available to the general public, that is suitable for revising the
35
- document straightforwardly with generic text editors or (for images
36
- composed of pixels) generic paint programs or (for drawings) some widely
37
- available drawing editor, and that is suitable for input to text
38
- formatters or for automatic translation to a variety of formats suitable
39
- for input to text formatters. A copy made in an otherwise Transparent
40
- file format whose markup, or absence of markup, has been arranged to
41
- thwart or discourage subsequent modification by readers is not
42
- Transparent. An image format is not Transparent if used for any
43
- substantial amount of text. A copy that is not "Transparent" is called
44
- "Opaque".</p><p>Examples of suitable formats for Transparent copies include plain
45
- ASCII without markup, Texinfo input format, LaTeX input format, SGML or
46
- XML using a publicly available DTD, and standard-conforming simple HTML,
47
- PostScript or PDF designed for human modification. Examples of
48
- transparent image formats include PNG, XCF and JPG. Opaque formats
49
- include proprietary formats that can be read and edited only by
50
- proprietary word processors, SGML or XML for which the DTD and/or
51
- processing tools are not generally available, and the machine-generated
52
- HTML, PostScript or PDF produced by some word processors for output
53
- purposes only.</p><p><a id="gfdl-title-page"></a>The "Title Page" means, for a printed book,
54
- the title page itself, plus such following pages as are needed to hold,
55
- legibly, the material this License requires to appear in the title page.
56
- For works in formats which do not have any title page as such, "Title
57
- Page" means the text near the most prominent appearance of the work's
58
- title, preceding the beginning of the body of the text.</p><p><a id="gfdl-entitled"></a>A section "Entitled XYZ" means a named subunit
59
- of the Document whose title either is precisely XYZ or contains XYZ in
60
- parentheses following text that translates XYZ in another language.
61
- (Here XYZ stands for a specific section name mentioned below, such as
62
- "Acknowledgements", "Dedications", "Endorsements", or "History".) To
63
- "Preserve the Title" of such a section when you modify the Document
64
- means that it remains a section "Entitled XYZ" according to this
65
- definition.</p><p>The Document may include Warranty Disclaimers next to the notice
66
- which states that this License applies to the Document. These Warranty
67
- Disclaimers are considered to be included by reference in this License,
68
- but only as regards disclaiming warranties: any other implication that
69
- these Warranty Disclaimers may have is void and has no effect on the
70
- meaning of this License.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-0.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-2.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">PREAMBLE </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> VERBATIM COPYING</td></tr></table></div></body></html>
data/doc/gfdl-10.html DELETED
@@ -1,15 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>FUTURE REVISIONS OF THIS LICENSE</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-9.html" title="TERMINATION" /><link rel="next" href="gfdl-addendum.html" title="ADDENDUM: How to use this License for&#10; your documents" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">FUTURE REVISIONS OF THIS LICENSE</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-9.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-addendum.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-10"></a>FUTURE REVISIONS OF THIS LICENSE</h2></div></div></div><p>The Free Software Foundation may publish new, revised versions of
4
- the GNU Free Documentation License from time to time. Such new versions
5
- will be similar in spirit to the present version, but may differ in
6
- detail to address new problems or concerns. See
7
- http://www.gnu.org/copyleft/.</p><p>Each version of the License is given a distinguishing version
8
- number. If the Document specifies that a particular numbered version of
9
- this License "or any later version" applies to it, you have the option
10
- of following the terms and conditions either of that specified version
11
- or of any later version that has been published (not as a draft) by the
12
- Free Software Foundation. If the Document does not specify a version
13
- number of this License, you may choose any version ever published (not
14
- as a draft) by the Free Software Foundation.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-9.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-addendum.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">TERMINATION </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> ADDENDUM: How to use this License for
15
- your documents</td></tr></table></div></body></html>
data/doc/gfdl-2.html DELETED
@@ -1,13 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>VERBATIM COPYING</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-1.html" title="APPLICABILITY AND DEFINITIONS" /><link rel="next" href="gfdl-3.html" title="COPYING IN QUANTITY" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">VERBATIM COPYING</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-1.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-3.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-2"></a>VERBATIM COPYING</h2></div></div></div><p>You may copy and distribute the Document in any medium, either
4
- commercially or noncommercially, provided that this License, the
5
- copyright notices, and the license notice saying this License applies to
6
- the Document are reproduced in all copies, and that you add no other
7
- conditions whatsoever to those of this License. You may not use
8
- technical measures to obstruct or control the reading or further copying
9
- of the copies you make or distribute. However, you may accept
10
- compensation in exchange for copies. If you distribute a large enough
11
- number of copies you must also follow the conditions in section 3.
12
- </p><p>You may also lend copies, under the same conditions stated above,
13
- and you may publicly display copies.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-1.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-3.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">APPLICABILITY AND DEFINITIONS </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> COPYING IN QUANTITY</td></tr></table></div></body></html>
data/doc/gfdl-3.html DELETED
@@ -1,31 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>COPYING IN QUANTITY</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-2.html" title="VERBATIM COPYING" /><link rel="next" href="gfdl-4.html" title="MODIFICATIONS" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">COPYING IN QUANTITY</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-2.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-4.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-3"></a>COPYING IN QUANTITY</h2></div></div></div><p>If you publish printed copies (or copies in media that commonly
4
- have printed covers) of the Document, numbering more than 100, and the
5
- Document's license notice requires Cover Texts, you must enclose the
6
- copies in covers that carry, clearly and legibly, all these Cover Texts:
7
- Front-Cover Texts on the front cover, and Back-Cover Texts on the back
8
- cover. Both covers must also clearly and legibly identify you as the
9
- publisher of these copies. The front cover must present the full title
10
- with all words of the title equally prominent and visible. You may add
11
- other material on the covers in addition. Copying with changes limited
12
- to the covers, as long as they preserve the title of the Document and
13
- satisfy these conditions, can be treated as verbatim copying in other
14
- respects.</p><p>If the required texts for either cover are too voluminous to fit
15
- legibly, you should put the first ones listed (as many as fit
16
- reasonably) on the actual cover, and continue the rest onto adjacent
17
- pages.</p><p>If you publish or distribute Opaque copies of the Document
18
- numbering more than 100, you must either include a machine-readable
19
- Transparent copy along with each Opaque copy, or state in or with each
20
- Opaque copy a computer-network location from which the general
21
- network-using public has access to download using public-standard
22
- network protocols a complete Transparent copy of the Document, free of
23
- added material. If you use the latter option, you must take reasonably
24
- prudent steps, when you begin distribution of Opaque copies in quantity,
25
- to ensure that this Transparent copy will remain thus accessible at the
26
- stated location until at least one year after the last time you
27
- distribute an Opaque copy (directly or through your agents or retailers)
28
- of that edition to the public.</p><p>It is requested, but not required, that you contact the authors of
29
- the Document well before redistributing any large number of copies, to
30
- give them a chance to provide you with an updated version of the
31
- Document.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-2.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-4.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">VERBATIM COPYING </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> MODIFICATIONS</td></tr></table></div></body></html>
data/doc/gfdl-4.html DELETED
@@ -1,75 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>MODIFICATIONS</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-3.html" title="COPYING IN QUANTITY" /><link rel="next" href="gfdl-5.html" title="COMBINING DOCUMENTS" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">MODIFICATIONS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-3.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-5.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-4"></a>MODIFICATIONS</h2></div></div></div><p>You may copy and distribute a Modified Version of the Document
4
- under the conditions of sections 2 and 3 above, provided that you
5
- release the Modified Version under precisely this License, with the
6
- Modified Version filling the role of the Document, thus licensing
7
- distribution and modification of the Modified Version to whoever
8
- possesses a copy of it. In addition, you must do these things in the
9
- Modified Version:</p><div class="orderedlist"><a id="gfdl-modif-cond"></a><p class="title"><b>GNU FDL Modification Conditions</b></p><ol type="A"><li>Use in the Title Page (and on the covers, if any) a
10
- title distinct from that of the Document, and from those of previous
11
- versions (which should, if there were any, be listed in the History
12
- section of the Document). You may use the same title as a previous
13
- version if the original publisher of that version gives permission.
14
- </li><li>List on the Title Page, as authors, one or more
15
- persons or entities responsible for authorship of the modifications in
16
- the Modified Version, together with at least five of the principal
17
- authors of the Document (all of its principal authors, if it has fewer
18
- than five), unless they release you from this requirement.
19
- </li><li>State on the Title page the name of the publisher of
20
- the Modified Version, as the publisher.</li><li>Preserve all the copyright notices of the Document.
21
- </li><li>Add an appropriate copyright notice for your
22
- modifications adjacent to the other copyright notices.
23
- </li><li>Include, immediately after the copyright notices, a
24
- license notice giving the public permission to use the Modified
25
- Version under the terms of this License, in the form shown in the
26
- <a href="gfdl-addendum.html" title="ADDENDUM: How to use this License for&#10; your documents">Addendum</a> below.
27
- </li><li>Preserve in that license notice the full lists of
28
- Invariant Sections and required Cover Texts given in the Document's
29
- license notice.</li><li>Include an unaltered copy of this License.
30
- </li><li>Preserve the section Entitled "History", Preserve its
31
- Title, and add to it an item stating at least the title, year, new
32
- authors, and publisher of the Modified Version as given on the Title
33
- Page. If there is no section Entitled "History" in the Document,
34
- create one stating the title, year, authors, and publisher of the
35
- Document as given on its Title Page, then add an item describing the
36
- Modified Version as stated in the previous sentence.
37
- </li><li>Preserve the network location, if any, given in the
38
- Document for public access to a Transparent copy of the Document, and
39
- likewise the network locations given in the Document for previous
40
- versions it was based on. These may be placed in the "History"
41
- section. You may omit a network location for a work that was
42
- published at least four years before the Document itself, or if the
43
- original publisher of the version it refers to gives permission.
44
- </li><li>For any section Entitled "Acknowledgements" or
45
- "Dedications", Preserve the Title of the section, and preserve in the
46
- section all the substance and tone of each of the contributor
47
- acknowledgements and/or dedications given therein.
48
- </li><li>Preserve all the Invariant Sections of the Document,
49
- unaltered in their text and in their titles. Section numbers or the
50
- equivalent are not considered part of the section titles.
51
- </li><li>Delete any section Entitled "Endorsements".
52
- Such a section may not be included in the Modified Version.
53
- </li><li>Do not retitle any existing section to be Entitled
54
- "Endorsements" or to conflict in title with any Invariant Section.
55
- </li><li>Preserve any Warranty Disclaimers.
56
- </li></ol></div><p>If the Modified Version includes new front-matter sections or
57
- appendices that qualify as Secondary Sections and contain no material
58
- copied from the Document, you may at your option designate some or all
59
- of these sections as invariant. To do this, add their titles to the
60
- list of Invariant Sections in the Modified Version's license notice.
61
- These titles must be distinct from any other section titles.</p><p>You may add a section Entitled "Endorsements", provided it
62
- contains nothing but endorsements of your Modified Version by various
63
- parties--for example, statements of peer review or that the text has
64
- been approved by an organization as the authoritative definition of a
65
- standard.</p><p>You may add a passage of up to five words as a Front-Cover Text,
66
- and a passage of up to 25 words as a Back-Cover Text, to the end of the
67
- list of Cover Texts in the Modified Version. Only one passage of
68
- Front-Cover Text and one of Back-Cover Text may be added by (or through
69
- arrangements made by) any one entity. If the Document already includes
70
- a cover text for the same cover, previously added by you or by
71
- arrangement made by the same entity you are acting on behalf of, you may
72
- not add another; but you may replace the old one, on explicit permission
73
- from the previous publisher that added the old one.</p><p>The author(s) and publisher(s) of the Document do not by this
74
- License give permission to use their names for publicity for or to
75
- assert or imply endorsement of any Modified Version.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-3.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-5.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">COPYING IN QUANTITY </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> COMBINING DOCUMENTS</td></tr></table></div></body></html>
data/doc/gfdl-5.html DELETED
@@ -1,20 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>COMBINING DOCUMENTS</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-4.html" title="MODIFICATIONS" /><link rel="next" href="gfdl-6.html" title="COLLECTIONS OF DOCUMENTS" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">COMBINING DOCUMENTS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-4.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-6.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-5"></a>COMBINING DOCUMENTS</h2></div></div></div><p>You may combine the Document with other documents released under
4
- this License, under the terms defined in <a href="gfdl-4.html" title="MODIFICATIONS">section
5
- 4</a> above for modified versions, provided that you include in the
6
- combination all of the Invariant Sections of all of the original
7
- documents, unmodified, and list them all as Invariant Sections of your
8
- combined work in its license notice, and that you preserve all their
9
- Warranty Disclaimers.</p><p>The combined work need only contain one copy of this License, and
10
- multiple identical Invariant Sections may be replaced with a single
11
- copy. If there are multiple Invariant Sections with the same name but
12
- different contents, make the title of each such section unique by adding
13
- at the end of it, in parentheses, the name of the original author or
14
- publisher of that section if known, or else a unique number. Make the
15
- same adjustment to the section titles in the list of Invariant Sections
16
- in the license notice of the combined work.</p><p>In the combination, you must combine any sections Entitled
17
- "History" in the various original documents, forming one section
18
- Entitled "History"; likewise combine any sections Entitled
19
- "Acknowledgements", and any sections Entitled "Dedications". You must
20
- delete all sections Entitled "Endorsements".</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-4.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-6.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">MODIFICATIONS </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> COLLECTIONS OF DOCUMENTS</td></tr></table></div></body></html>
data/doc/gfdl-6.html DELETED
@@ -1,12 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>COLLECTIONS OF DOCUMENTS</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-5.html" title="COMBINING DOCUMENTS" /><link rel="next" href="gfdl-7.html" title="AGGREGATION WITH INDEPENDENT WORKS" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">COLLECTIONS OF DOCUMENTS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-5.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-7.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-6"></a>COLLECTIONS OF DOCUMENTS</h2></div></div></div><p>You may make a collection consisting of the Document and other
4
- documents released under this License, and replace the individual copies
5
- of this License in the various documents with a single copy that is
6
- included in the collection, provided that you follow the rules of this
7
- License for verbatim copying of each of the documents in all other
8
- respects.</p><p>You may extract a single document from such a collection, and
9
- distribute it individually under this License, provided you insert a
10
- copy of this License into the extracted document, and follow this
11
- License in all other respects regarding verbatim copying of that
12
- document.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-5.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-7.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">COMBINING DOCUMENTS </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> AGGREGATION WITH INDEPENDENT WORKS</td></tr></table></div></body></html>
data/doc/gfdl-7.html DELETED
@@ -1,16 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>AGGREGATION WITH INDEPENDENT WORKS</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-6.html" title="COLLECTIONS OF DOCUMENTS" /><link rel="next" href="gfdl-8.html" title="TRANSLATION" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">AGGREGATION WITH INDEPENDENT WORKS</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-6.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-8.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-7"></a>AGGREGATION WITH INDEPENDENT WORKS</h2></div></div></div><p>A compilation of the Document or its derivatives with other
4
- separate and independent documents or works, in or on a volume of a
5
- storage or distribution medium, is called an "aggregate" if the
6
- copyright resulting from the compilation is not used to limit the legal
7
- rights of the compilation's users beyond what the individual works
8
- permit. When the Document is included in an aggregate, this License does
9
- not apply to the other works in the aggregate which are not themselves
10
- derivative works of the Document.</p><p>If the Cover Text requirement of section 3 is applicable to these
11
- copies of the Document, then if the Document is less than one half of
12
- the entire aggregate, the Document's Cover Texts may be placed on covers
13
- that bracket the Document within the aggregate, or the electronic
14
- equivalent of covers if the Document is in electronic form. Otherwise
15
- they must appear on printed covers that bracket the whole
16
- aggregate.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-6.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-8.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">COLLECTIONS OF DOCUMENTS </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> TRANSLATION</td></tr></table></div></body></html>
data/doc/gfdl-8.html DELETED
@@ -1,17 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>TRANSLATION</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-7.html" title="AGGREGATION WITH INDEPENDENT WORKS" /><link rel="next" href="gfdl-9.html" title="TERMINATION" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">TRANSLATION</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-7.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-9.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-8"></a>TRANSLATION</h2></div></div></div><p>Translation is considered a kind of modification, so you may
4
- distribute translations of the Document under the terms of section 4.
5
- Replacing Invariant Sections with translations requires special
6
- permission from their copyright holders, but you may include
7
- translations of some or all Invariant Sections in addition to the
8
- original versions of these Invariant Sections. You may include a
9
- translation of this License, and all the license notices in the
10
- Document, and any Warranty Disclaimers, provided that you also include
11
- the original English version of this License and the original versions
12
- of those notices and disclaimers. In case of a disagreement between the
13
- translation and the original version of this License or a notice or
14
- disclaimer, the original version will prevail.</p><p>If a section in the Document is Entitled "Acknowledgements",
15
- "Dedications", or "History", the requirement (section 4) to Preserve its
16
- Title (section 1) will typically require changing the actual
17
- title.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-7.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-9.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">AGGREGATION WITH INDEPENDENT WORKS </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> TERMINATION</td></tr></table></div></body></html>
data/doc/gfdl-9.html DELETED
@@ -1,9 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>TERMINATION</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-8.html" title="TRANSLATION" /><link rel="next" href="gfdl-10.html" title="FUTURE REVISIONS OF THIS LICENSE" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">TERMINATION</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-8.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> <a accesskey="n" href="gfdl-10.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-9"></a>TERMINATION</h2></div></div></div><p>You may not copy, modify, sublicense, or distribute the Document
4
- except as expressly provided for under this License. Any other attempt
5
- to copy, modify, sublicense or distribute the Document is void, and will
6
- automatically terminate your rights under this License. However,
7
- parties who have received copies, or rights, from you under this License
8
- will not have their licenses terminated so long as such parties remain
9
- in full compliance.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-8.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="gfdl-10.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">TRANSLATION </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> FUTURE REVISIONS OF THIS LICENSE</td></tr></table></div></body></html>
data/doc/gfdl-addendum.html DELETED
@@ -1,25 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>ADDENDUM: How to use this License for
4
- your documents</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /><link rel="prev" href="gfdl-10.html" title="FUTURE REVISIONS OF THIS LICENSE" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">ADDENDUM: How to use this License for
5
- your documents</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="gfdl-10.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Appendix A. GNU Free Documentation License</th><td width="20%" align="right"> </td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="gfdl-addendum"></a>ADDENDUM: How to use this License for
6
- your documents</h2></div></div></div><p>To use this License in a document you have written, include a copy
7
- of the License in the document and put the following copyright and
8
- license notices just after the title page:</p><div class="blockquote"><a id="copyright-sample"></a><blockquote class="blockquote"><div class="blockquote-title"><p><b>Sample Invariant Sections list</b></p></div><p>
9
- Copyright (c) YEAR YOUR NAME.
10
- Permission is granted to copy, distribute and/or modify this document
11
- under the terms of the GNU Free Documentation License, Version 1.2
12
- or any later version published by the Free Software Foundation;
13
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
14
- A copy of the license is included in the section entitled "GNU
15
- Free Documentation License".
16
- </p></blockquote></div><p>If you have Invariant Sections, Front-Cover Texts and Back-Cover
17
- Texts, replace the "with...Texts." line with this:</p><div class="blockquote"><a id="inv-cover-sample"></a><blockquote class="blockquote"><div class="blockquote-title"><p><b>Sample Invariant Sections list</b></p></div><p>
18
- with the Invariant Sections being LIST THEIR TITLES, with the
19
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
20
- </p></blockquote></div><p>If you have Invariant Sections without Cover Texts, or some other
21
- combination of the three, merge those two alternatives to suit the
22
- situation.</p><p>If your document contains nontrivial examples of program code, we
23
- recommend releasing these examples in parallel under your choice of free
24
- software license, such as the GNU General Public License, to permit
25
- their use in free software.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="gfdl-10.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="gfdl.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> </td></tr><tr><td width="40%" align="left" valign="top">FUTURE REVISIONS OF THIS LICENSE </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>
data/doc/gfdl.html DELETED
@@ -1,11 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Appendix A. GNU Free Documentation License</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="index.html" title="Ruby-VPI user manual" /><link rel="prev" href="glossary.html" title="Glossary" /><link rel="next" href="gfdl-0.html" title="PREAMBLE" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Appendix A. GNU Free Documentation License</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="glossary.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="gfdl-0.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="appendix" lang="en" xml:lang="en"><div class="titlepage"><div><div><h1 class="title"><a id="gfdl"></a>GNU Free Documentation License</h1></div><div><p class="releaseinfo">Version 1.2, November 2002</p></div><div><p class="copyright">Copyright © 2000,2001,2002 Free Software Foundation, Inc.</p></div><div><div class="legalnotice"><a id="gfdl-legalnotice"></a><div class="address"><p>Free Software Foundation, Inc.<br />
4
-  <span class="street">51 Franklin St, Fifth Floor</span>,<br />
5
-  <span class="city">Boston</span>,<br />
6
-  <span class="state">MA</span><br />
7
-  <span class="postcode">02110-1301</span><br />
8
-  <span class="country">USA</span><br />
9
-  </p></div><p>Everyone is permitted to copy and distribute verbatim copies
10
- of this license document, but changing it is not allowed.</p></div></div><div><p class="pubdate">Version 1.2, November 2002</p></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="gfdl-0.html">PREAMBLE</a></span></dt><dt><span class="section"><a href="gfdl-1.html">APPLICABILITY AND DEFINITIONS</a></span></dt><dt><span class="section"><a href="gfdl-2.html">VERBATIM COPYING</a></span></dt><dt><span class="section"><a href="gfdl-3.html">COPYING IN QUANTITY</a></span></dt><dt><span class="section"><a href="gfdl-4.html">MODIFICATIONS</a></span></dt><dt><span class="section"><a href="gfdl-5.html">COMBINING DOCUMENTS</a></span></dt><dt><span class="section"><a href="gfdl-6.html">COLLECTIONS OF DOCUMENTS</a></span></dt><dt><span class="section"><a href="gfdl-7.html">AGGREGATION WITH INDEPENDENT WORKS</a></span></dt><dt><span class="section"><a href="gfdl-8.html">TRANSLATION</a></span></dt><dt><span class="section"><a href="gfdl-9.html">TERMINATION</a></span></dt><dt><span class="section"><a href="gfdl-10.html">FUTURE REVISIONS OF THIS LICENSE</a></span></dt><dt><span class="section"><a href="gfdl-addendum.html">ADDENDUM: How to use this License for
11
- your documents</a></span></dt></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="glossary.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="gfdl-0.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Glossary </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> PREAMBLE</td></tr></table></div></body></html>
data/doc/glossary.html DELETED
@@ -1,3 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Glossary</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="index.html" title="Ruby-VPI user manual" /><link rel="prev" href="problems.vsim.html" title="Mentor Modelsim" /><link rel="next" href="gfdl.html" title="Appendix A. GNU Free Documentation License" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Glossary</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problems.vsim.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="gfdl.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="glossary"><div class="titlepage"><div><div><h2 class="title"><a id="glossary"></a>Glossary</h2></div></div></div><div class="glossdiv"><h3 class="title">B</h3><dl><dt><a id="term..bench"></a>Bench</dt><dd><p>An environment in which a <a href="glossary.html#term..design">Design</a> is verified against a <a href="glossary.html#term..specification">Specification</a>. Often, it is used to emulate conditions in which the design will be eventually deployed.</p></dd><dt><a id="term..BDD"></a><span class="acronym">BDD</span></dt><dd><p>Behavior driven development.</p><p>A software development methodology which emphasizes thinking in terms of behavior when designing, implementing, and verifying software. See the <a href="http://behaviour-driven.org/" target="_top">official wiki</a> for more information.</p><p>See Also <a href="glossary.html#term..TDD">TDD</a>, <a href="glossary.html#term..rspec">rSpec</a>.</p></dd></dl></div><div class="glossdiv"><h3 class="title">D</h3><dl><dt><a id="term..design"></a>Design</dt><dd><p>An idea or entity that is verified against a <a href="glossary.html#term..specification">Specification</a> in order to ensure correctness or soundness of its being. In other words, it is the thing being checked: does it work or not?</p></dd></dl></div><div class="glossdiv"><h3 class="title">E</h3><dl><dt><a id="term..expectation"></a>Expectation</dt><dd><p>The desired response to some stimulus.</p></dd></dl></div><div class="glossdiv"><h3 class="title">H</h3><dl><dt><a id="term..handle"></a>Handle</dt><dd><p>An object in a Verilog simulation. For example, a handle can represent a wire, register, module, if-statement, expression, and so on.</p></dd></dl></div><div class="glossdiv"><h3 class="title">R</h3><dl><dt><a id="term..rake"></a>Rake</dt><dd><div class="blockquote"><table border="0" width="100%" cellspacing="0" cellpadding="0" class="blockquote" summary="Block quote"><tr><td width="10%" valign="top"> </td><td width="80%" valign="top"><p>Rake is a build tool, written in Ruby, using Ruby as a build language. Rake is similar to make in scope and purpose.</p></td><td width="10%" valign="top"> </td></tr><tr><td width="10%" valign="top"> </td><td colspan="2" align="right" valign="top">--<span class="attribution"><a href="http://docs.rubyrake.org/" target="_top">Rake documentation</a></span></td></tr></table></div><p>See the <a href="http://rake.rubyforge.org/" target="_top">Rake website</a> for more information.</p></dd><dt><a id="term..rspec"></a>rSpec</dt><dd><p>Ruby framework for BDD. See the <a href="http://rspec.rubyforge.org" target="_top">rSpec website</a> and <a href="http://rspec.rubyforge.org/tutorials/index.html" target="_top">rSpec tutorial</a> for more information.</p><p>See Also <a href="glossary.html#term..BDD"><span class="acronym">BDD</span></a>.</p></dd></dl></div><div class="glossdiv"><h3 class="title">S</h3><dl><dt><a id="term..specification"></a>Specification</dt><dd><p>A set of <a href="glossary.html#term..expectation">Expectation</a>s which define the desired behavior of a <a href="glossary.html#term..design">Design</a> when it is subjected to certain conditions.</p></dd></dl></div><div class="glossdiv"><h3 class="title">T</h3><dl><dt><a id="term..TDD"></a>TDD</dt><dd><p>Test Driven Development.</p><p>See Also <a href="glossary.html#term..BDD"><span class="acronym">BDD</span></a>.</p></dd><dt><a id="term..test"></a>Test</dt><dd><p>Something that checks if a <a href="glossary.html#term..design">Design</a> satisfies a <a href="glossary.html#term..specification">Specification</a>.</p><p>See Also <a href="glossary.html#term..test-bench">Test bench</a>.</p></dd><dt><a id="term..test-bench"></a>Test bench</dt><dd><p>An allusion to <a href="background.terminology.html" title="Terminology">a bench in an electronics laboratory</a>, or so it seems.</p><p>See Also <a href="glossary.html#term..test">Test</a>.</p></dd></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problems.vsim.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="gfdl.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Mentor Modelsim </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Appendix A. GNU Free Documentation License</td></tr></table></div></body></html>
data/doc/hacking.html DELETED
@@ -1,3 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Chapter 5. Hacking</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="index.html" title="Ruby-VPI user manual" /><link rel="prev" href="usage.examples.html" title="Examples" /><link rel="next" href="hacking.release-packages.html" title="Building release packages" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 5. Hacking</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="usage.examples.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center"> </th><td width="20%" align="right"> <a accesskey="n" href="hacking.release-packages.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="chapter" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="hacking"></a>Chapter 5. Hacking</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="hacking.release-packages.html">Building release packages</a></span></dt></dl></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="usage.examples.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"> </td><td width="40%" align="right"> <a accesskey="n" href="hacking.release-packages.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Examples </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Building release packages</td></tr></table></div></body></html>
data/doc/hacking.release-packages.html DELETED
@@ -1,7 +0,0 @@
1
- <?xml version="1.0" encoding="UTF-8" standalone="no"?>
2
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
- <html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Building release packages</title><link rel="stylesheet" href="styles/manual.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.68.1" /><link rel="start" href="index.html" title="Ruby-VPI user manual" /><link rel="up" href="hacking.html" title="Chapter 5. Hacking" /><link rel="prev" href="hacking.html" title="Chapter 5. Hacking" /><link rel="next" href="problems.html" title="Chapter 6. Known problems" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Building release packages</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hacking.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 5. Hacking</th><td width="20%" align="right"> <a accesskey="n" href="problems.html"><img src="images/next.png" alt="Next" /></a></td></tr></table><hr /></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="hacking.release-packages"></a>Building release packages</h2></div></div></div><p>In addition to the "normal requirements":./doc/usage.requirements.html, you need the following software to build release packages:
4
-
5
- </p><div class="variablelist"><dl><dt><span class="term"><a href="http://www.docbook.org/" target="_top">DocBook-XML</a></span></dt><dd><p></p></dd><dt><span class="term">xsltproc</span></dt><dd><p></p></dd><dt><span class="term">xmlto</span></dt><dd><p></p></dd><dt><span class="term"><a href="http://rubyforge.org/projects/redcloth/" target="_top">RedCloth</a></span></dt><dd><p></p></dd><dt><span class="term"><a href="http://www.swig.org/" target="_top">SWIG</a></span></dt><dd><p></p></dd></dl></div><p>
6
-
7
- Once you have satisfied these requirements, you can run <span><strong class="command">rake <span class="action">release</span></strong></span> to build the release packages. Also, see the output of <span><strong class="command">rake <code class="option">-T</code></strong></span> for more build options.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hacking.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="hacking.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="problems.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 5. Hacking </td><td width="20%" align="center"><a accesskey="h" href="index.html"><img src="images/home.png" alt="Home" /></a></td><td width="40%" align="right" valign="top"> Chapter 6. Known problems</td></tr></table></div></body></html>
data/doc/images/ChangeLog DELETED
@@ -1,27 +0,0 @@
1
- 2005-01-24 Jirka Kosek <kosek@users.sourceforge.net>
2
-
3
- * caution.svg, home.svg, important.svg, next.svg, prev.svg, tip.svg, up.svg, warning.svg:
4
- Updated and more complete set of SVG icons.
5
-
6
- 2005-01-05 Jirka Kosek <kosek@users.sourceforge.net>
7
-
8
- * caution.svg, important.svg, note.svg, tip.svg, warning.svg:
9
- New file.
10
-
11
- 2002-02-11 Norman Walsh <nwalsh@users.sourceforge.net>
12
-
13
- * draft.png: Updated draft image
14
-
15
- 2002-01-29 Norman Walsh <nwalsh@users.sourceforge.net>
16
-
17
- * blank.png, draft.png: New file.
18
-
19
- 2001-11-06 Robert Stayton <bobstayton@users.sourceforge.net>
20
-
21
- * home.gif, next.gif, prev.gif, up.gif: New file.
22
-
23
- 2001-04-02 Norman Walsh <nwalsh@users.sourceforge.net>
24
-
25
- * caution.gif, caution.png, caution.tif, home.png, important.gif, important.png, important.tif, next.png, note.gif, note.png, note.tif, prev.png, tip.gif, tip.png, tip.tif, toc-blank.png, toc-minus.png, toc-plus.png, up.png, warning.gif, warning.png, warning.tif:
26
- New file.
27
-