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/doc/problem.ivl.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>Icarus Verilog</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="problems.html" title="Chapter 6. Known problems" /><link rel="prev" href="problems.ruby.html" title="Ruby" /><link rel="next" href="problems.vsim.html" title="Mentor Modelsim" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Icarus Verilog</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problems.ruby.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 6. Known problems</th><td width="20%" align="right"> <a accesskey="n" href="problems.vsim.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="problem.ivl"></a>Icarus Verilog</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="problems.ivl.vpi_handle_by_name"></a>vpi_handle_by_name</h3></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="problems.ivl.vpi_handle_by_name.absolute-paths"></a>Give full paths to Verilog objects</h4></div></div></div><p>In version 0.8 and snapshot 20061009 of Icarus Verilog, the <code class="function">vpi_handle_by_name</code> function requires an <span class="emphasis"><em>absolute</em></span> path (including the name of the bench which instantiates the design) to a Verilog object. In addition, <code class="function">vpi_handle_by_name</code> is unable to retrieve the handle for a module parameter.</p><p>For example, consider <a href="problem.ivl.html#ex..TestFoo" title="Example 6.1. Part of a bench which instantiates a Verilog design">Example 6.1, “Part of a bench which instantiates a Verilog design”</a>. Here, one needs to specify <code class="code">TestFoo.my_foo.clk</code> instead of <code class="code">my_foo.clk</code> in order to access the <code class="varname">clk</code> input of the <code class="varname">my_foo</code> module instance.</p><div class="example"><a id="ex..TestFoo"></a><p class="title"><b>Example 6.1. Part of a bench which instantiates a Verilog design</b></p><pre class="programlisting">
4
- <span class="token">module</span> TestFoo;
5
- <span class="type">reg</span> <code class="varname">clk_reg</code>;
6
- Foo <code class="varname">my_foo</code>(<em class="parameter"><code>.clk</code></em>(<code class="varname">clk_reg</code>));
7
- <span class="token">endmodule</span>
8
- </pre></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h4 class="title"><a id="problems.ivl.vpi_handle_by_name.connect-registers"></a>Registers must be connected</h4></div></div></div><p>In version 0.8 of Icarus Verilog, if you want to access a register in a design, then it must be connected to something (either assigned to a wire or passed as a parameter to a module instantiation). Otherwise, you will get a <code class="literal">nil</code> value as the result of <code class="function">vpi_handle_by_name</code> method.</p><p>For example, suppose you wanted to access the <code class="varname">clk_reg</code> register, from the bench shown in <a href="problem.ivl.html#ex..TestFoo_bad" title="Example 6.2. Bad design with unconnected registers">Example 6.2, “Bad design with unconnected registers”</a>. If you execute the statement <code class="code"><code class="varname">clk_reg</code> = <code class="function">vpi_handle_by_name</code>(<em class="parameter"><code><code class="literal">"TestFoo.clk_reg"</code></code></em>, <em class="parameter"><code><code class="literal">nil</code></code></em>)</code> in a specification, then you will discover that the <code class="function">vpi_handle_by_name</code> method returns <code class="literal">nil</code> instead of a handle to the <code class="varname">clk_reg</code> register.</p><p>The solution is to change the design such that it appears like the one shown in <a href="problem.ivl.html#ex..TestFoo_fix" title="Example 6.3. Fixed design with wired registers">Example 6.3, “Fixed design with wired registers”</a> where the register is connected to a wire, or <a href="problem.ivl.html#ex..TestFoo" title="Example 6.1. Part of a bench which instantiates a Verilog design">Example 6.1, “Part of a bench which instantiates a Verilog design”</a> where the register is connected to a module instantiation.</p><div class="example"><a id="ex..TestFoo_bad"></a><p class="title"><b>Example 6.2. Bad design with unconnected registers</b></p><p>Here the <code class="varname">clk_reg</code> register is not connected to anything.</p><pre class="programlisting">
9
- <span class="token">module</span> TestFoo;
10
- <span class="type">reg</span> <code class="varname">clk_reg</code>;
11
- <span class="token">endmodule</span>
12
- </pre></div><div class="example"><a id="ex..TestFoo_fix"></a><p class="title"><b>Example 6.3. Fixed design with wired registers</b></p><p>Here the <code class="varname">clk_reg</code> register is connected to the <code class="varname">clk_wire</code> wire.</p><pre class="programlisting">
13
- <span class="token">module</span> TestFoo;
14
- <span class="type">reg</span> <code class="varname">clk_reg</code>;
15
- <span class="type">wire</span> <code class="varname">clk_wire</code>;
16
- <span class="token">assign</span> <code class="varname">clk_wire</code> = <code class="varname">clk_reg</code>;
17
- <span class="token">endmodule</span>
18
- </pre></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="problems.ivl.vpi_reset"></a>Vpi::reset</h3></div></div></div><div class="caution" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Caution: Deprecated method"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Caution]" src="images/caution.png" /></td><th align="left">Deprecated method</th></tr><tr><td align="left" valign="top"><p>The <code class="function">vpi_control</code> method was removed in release 3.0.0 (2006-04-23) of <span class="application">Ruby-VPI</span>, and is deprecated. Please use <code class="code"><code class="constant">Vpi</code>::<code class="function">vpi_control</code>(<em class="parameter"><code><code class="constant">VpiReset</code></code></em>)</code> instead.</p></td></tr></table></div><p>In version 0.8 of Icarus Verilog, the <code class="code"><code class="function">vpi_control</code>(<em class="parameter"><code><code class="constant">vpiReset</code></code></em>)</code> <span class="acronym">VPI</span> function causes an assertion to fail inside the simulator. As a result, the simulation terminates and a core dump is produced.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problems.ruby.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="problems.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="problems.vsim.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Ruby </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"> Mentor Modelsim</td></tr></table></div></body></html>
data/doc/problems.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 6. Known problems</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="hacking.release-packages.html" title="Building release packages" /><link rel="next" href="problems.ruby.html" title="Ruby" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 6. Known problems</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="hacking.release-packages.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="problems.ruby.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="problems"></a>Chapter 6. Known problems</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="problems.ruby.html">Ruby</a></span></dt><dd><dl><dt><span class="section"><a href="problems.ruby.html#problems.ruby.SystemStackError">SystemStackError</a></span></dt><dt><span class="section"><a href="problems.ruby.html#problems.ruby.xUnit">test/unit</a></span></dt></dl></dd><dt><span class="section"><a href="problem.ivl.html">Icarus Verilog</a></span></dt><dd><dl><dt><span class="section"><a href="problem.ivl.html#problems.ivl.vpi_handle_by_name">vpi_handle_by_name</a></span></dt><dt><span class="section"><a href="problem.ivl.html#problems.ivl.vpi_reset">Vpi::reset</a></span></dt></dl></dd><dt><span class="section"><a href="problems.vsim.html">Mentor Modelsim</a></span></dt><dd><dl><dt><span class="section"><a href="problems.vsim.html#problems.vsim.ruby_run">ruby_run()</a></span></dt></dl></dd></dl></div><p>This chapter presents known problems and possible solutions. In addition, previously solved problems have been retained for historical reference.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="hacking.release-packages.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="problems.ruby.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Building release packages </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"> Ruby</td></tr></table></div></body></html>
data/doc/problems.ruby.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>Ruby</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="problems.html" title="Chapter 6. Known problems" /><link rel="prev" href="problems.html" title="Chapter 6. Known problems" /><link rel="next" href="problem.ivl.html" title="Icarus Verilog" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Ruby</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problems.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 6. Known problems</th><td width="20%" align="right"> <a accesskey="n" href="problem.ivl.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="problems.ruby"></a>Ruby</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="problems.ruby.SystemStackError"></a>SystemStackError</h3></div></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Problem solved"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png" /></td><th align="left">Problem solved</th></tr><tr><td align="left" valign="top"><p>This problem was fixed in release 2.0.0 (2006-04-17). If it still occurs, then <a href="introduction.resources.html" title="Resources">please report it</a>.</p></td></tr></table></div><p>If a “<span class="quote">stack level too deep (SystemStackError)</span>” error occurs during the simulation, then increase the system-resource limit for stack-size by running the command <span><strong class="command">ulimit <code class="option">-s</code> <em class="replaceable"><code>unlimited</code></em></strong></span> before starting the simulation.</p></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="problems.ruby.xUnit"></a>test/unit</h3></div></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Problem solved"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png" /></td><th align="left">Problem solved</th></tr><tr><td align="left" valign="top"><p>This problem was fixed in release 2.0.0 (2006-04-17). If it still occurs, then <a href="introduction.resources.html" title="Resources">please report it</a>.</p></td></tr></table></div><p>If your specification employs Ruby's unit testing framework, then you will encounter the error: “<span class="quote">[BUG] cross-thread violation on rb_gc()</span>”.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problems.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="problems.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="problem.ivl.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 6. Known problems </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"> Icarus Verilog</td></tr></table></div></body></html>
data/doc/problems.vsim.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>Mentor Modelsim</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="problems.html" title="Chapter 6. Known problems" /><link rel="prev" href="problem.ivl.html" title="Icarus Verilog" /><link rel="next" href="glossary.html" title="Glossary" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Mentor Modelsim</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="problem.ivl.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 6. Known problems</th><td width="20%" align="right"> <a accesskey="n" href="glossary.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="problems.vsim"></a>Mentor Modelsim</h2></div></div></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="problems.vsim.ruby_run"></a>ruby_run()</h3></div></div></div><div class="note" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note: Problem solved"><tr><td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="images/note.png" /></td><th align="left">Problem solved</th></tr><tr><td align="left" valign="top"><p>This problem was fixed in release 2.0.0 (2006-04-17). If it still occurs, then <a href="introduction.resources.html" title="Resources">please report it</a>.</p></td></tr></table></div><p>Version 6.1b of Mentor Modelsim doesn't play nicely with either an embedded Ruby interpreter or POSIX threads in a PLI application. When <span class="application">Ruby-VPI</span> invokes the <code class="function">ruby_run</code> function (which starts the Ruby interpreter), the simulator terminates immediately with an exit status of 0.</p></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="problem.ivl.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="problems.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="glossary.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Icarus Verilog </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"> Glossary</td></tr></table></div></body></html>
data/doc/setup.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 3. Setup</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="background.running-tests.html" title="Running a test" /><link rel="next" href="setup.reqs.html" title="Requirements" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Chapter 3. Setup</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="background.running-tests.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="setup.reqs.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="setup"></a>Chapter 3. Setup</h2></div></div></div><div class="toc"><p><b>Table of Contents</b></p><dl><dt><span class="section"><a href="setup.reqs.html">Requirements</a></span></dt><dd><dl><dt><span class="section"><a href="setup.reqs.html#setup.reqs.optional">Recommendations</a></span></dt></dl></dd><dt><span class="section"><a href="setup.installation.html">Installation</a></span></dt><dd><dl><dt><span class="section"><a href="setup.installation.html#setup.installation.windows">Installing on Windows</a></span></dt></dl></dd><dt><span class="section"><a href="setup.maintenance.html">Maintenance</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="background.running-tests.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="setup.reqs.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Running a test </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"> Requirements</td></tr></table></div></body></html>
data/doc/setup.installation.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>Installation</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="setup.html" title="Chapter 3. Setup" /><link rel="prev" href="setup.reqs.html" title="Requirements" /><link rel="next" href="setup.maintenance.html" title="Maintenance" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Installation</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="setup.reqs.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 3. Setup</th><td width="20%" align="right"> <a accesskey="n" href="setup.maintenance.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="setup.installation"></a>Installation</h2></div></div></div><p>Once you have satisfied the <a href="setup.reqs.html" title="Requirements">necessary requirements</a>, you can install <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">install</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span>. RubyGems will install <span class="application">Ruby-VPI</span> into the system gem directory, whose path can be determined by running the command <span><strong class="command">gem <span class="action">env</span> <em class="replaceable"><code>gemdir</code></em></strong></span>. Within this directory, there is a "gems" subdirectory which contains the <span class="application">Ruby-VPI</span> installation, as illustrated below.</p><pre class="screen">
4
- <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">gem <span class="action">env</span> <em class="replaceable"><code>gemdir</code></em></strong></span></code></strong>
5
- <code class="computeroutput">/usr/lib/ruby/gems/1.8</code>
6
-
7
- <code class="prompt">$</code> <strong class="userinput"><code><span><strong class="command">ls <code class="option">-d</code> <em class="replaceable"><code>/usr/lib/ruby/gems/1.8</code></em>/gems/ruby-vpi-*</strong></span></code></strong>
8
- <code class="computeroutput">/usr/lib/ruby/gems/1.8/gems/ruby-vpi-7.0.0/</code>
9
- </pre><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="setup.installation.windows"></a>Installing on Windows</h3></div></div></div><div class="procedure"><ol type="1"><li><p>Install <a href="http://www.cygwin.com" target="_top">Cygwin</a>, the Linux-like environment for Windows.</p></li><li><p>Search for object files whose names end with <code class="filename">.so</code>, <code class="filename">.o</code>, or <code class="filename">.dll</code> in your Verilog simulator's installation directory.</p></li><li><p>Determine which object files, among those found in the previous step, contain symbols whose names begin with <span class="symbol">_vpi</span><sup>[<a id="id2528554" href="#ftn.id2528554">1</a>]</sup> by running the command <span><strong class="command">for x in *.{o,so,dll}; do nm $x | grep -q '[Tt] _vpi' &gt; /dev/null &amp;&amp; echo $x; done</strong></span> in Cygwin.</p><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>If you are using Mentor Modelsim, the desired object file can be found at a path similar to <code class="filename">C:\Modeltech\win32\libvsim.dll</code>.</p></td></tr></table></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>If you are using GPL Cver, the desired object file can be found at a path similar to <code class="filename">C:\gplcver\objs\v_vpi.o</code>.</p></td></tr></table></div></li><li><p>Assign the path of the object file (determined in the previous step) to the <code class="varname">LDFLAGS</code> environment variable. For example, if the object file's path is <em class="replaceable"><code>/foo/bar/vpi.so</code></em>, then you would run the command <span><strong class="command">export <code class="varname">LDFLAGS</code>=<em class="replaceable"><code>/foo/bar/vpi.so</code></em></strong></span> in Cygwin.</p></li><li><p>You may now install <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">install</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span> in Cygwin.</p></li></ol></div></div><div class="footnotes"><br /><hr width="100" align="left" /><div class="footnote"><p><sup>[<a id="ftn.id2528554" href="#id2528554">1</a>] </sup>Because <span class="application">Ruby-VPI</span> makes use of the <span class="acronym">VPI</span> C-language interface, it links to symbols whose names begin with <span class="symbol">_vpi</span>. It is possible for these symbols to be undefined when <span class="application">Ruby-VPI</span> is compiled under GNU/Linux and similar operating systems. In contrast, one <a href="http://sourceware.org/ml/cygwin/2001-12/msg01293.html" target="_top">cannot compile a shared object file with references to undefined symbols under Windows</a>. Thus, we must find a Verilog simulator's shared object file, which contains definitions of all <span class="acronym">VPI</span> symbols, and give this file to the linker when compiling <span class="application">Ruby-VPI</span>.</p></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="setup.reqs.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="setup.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="setup.maintenance.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Requirements </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"> Maintenance</td></tr></table></div></body></html>
data/doc/setup.maintenance.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>Maintenance</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="setup.html" title="Chapter 3. Setup" /><link rel="prev" href="setup.installation.html" title="Installation" /><link rel="next" href="usage.html" title="Chapter 4. Usage" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Maintenance</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="setup.installation.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 3. Setup</th><td width="20%" align="right"> <a accesskey="n" href="usage.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="setup.maintenance"></a>Maintenance</h2></div></div></div><p>You can uninstall <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">uninstall</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span>. Furthermore, you can upgrade to the latest release of <span class="application">Ruby-VPI</span> by running the command <span><strong class="command">gem <span class="action">update</span> <em class="replaceable"><code>ruby-vpi</code></em></strong></span>. Finally, you can learn more about using and manipulating RubyGems in <a href="http://www.rubygems.org" target="_top">the RubyGems user manual</a>.</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="setup.installation.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="setup.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="usage.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Installation </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 4. Usage</td></tr></table></div></body></html>
data/doc/setup.reqs.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>Requirements</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="setup.html" title="Chapter 3. Setup" /><link rel="prev" href="setup.html" title="Chapter 3. Setup" /><link rel="next" href="setup.installation.html" title="Installation" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">Requirements</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="setup.html"><img src="images/prev.png" alt="Prev" /></a> </td><th width="60%" align="center">Chapter 3. Setup</th><td width="20%" align="right"> <a accesskey="n" href="setup.installation.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="setup.reqs"></a>Requirements</h2></div></div></div><p>The following software is necessary in order to use <span class="application">Ruby-VPI</span>.</p><div class="variablelist"><dl><dt><span class="term">Verilog simulator</span></dt><dd><p><span class="application">Ruby-VPI</span> is known to work with the following simulators. Nevertheless, you should be able to use it with any Verilog simulator that supports <span class="acronym">VPI</span>.</p><div class="variablelist"><dl><dt><span class="term"><a href="http://www.icarus.com/eda/Verilog/" target="_top">Icarus Verilog</a></span></dt><dd><p>Version 0.8 or newer is acceptable.</p></dd><dt><span class="term"><a href="http://www.pragmatic-c.com/gpl-cver/" target="_top">GPL Cver</a></span></dt><dd><p>Version 2.11a or newer is acceptable.</p></dd><dt><span class="term"><a href="http://www.synopsys.com/products/simulation/simulation.html" target="_top">Synopsys VCS</a></span></dt><dd><p>Any version that supports the <code class="option">-load</code> option is acceptable.</p></dd><dt><span class="term"><a href="http://www.model.com" target="_top">Mentor Modelsim</a></span></dt><dd><p>Any version that supports the <code class="option">-pli</code> option is acceptable.</p></dd></dl></div></dd><dt><span class="term"><span class="application">make</span></span></dt><dd><p><a href="http://www.gnu.org/software/make/" target="_top"><span class="acronym">GNU</span> make</a> is preferred but any distribution of <span><strong class="command">make</strong></span> should be acceptable.</p></dd><dt><span class="term">C compiler</span></dt><dd><p><a href="http://www.gnu.org/software/gcc/" target="_top"><span class="acronym">GNU</span> Compiler Collection (<span class="acronym">GCC</span>)</a> is preferred but any C compiler should be acceptable.</p></dd><dt><span class="term"><a href="http://en.wikipedia.org/wiki/Pthreads" target="_top"><span class="acronym">POSIX</span> threads (pthreads)</a></span></dt><dd><p>Header and linkable object files, and operating system support for this library are necessary.</p></dd><dt><span class="term"><a href="http://www.ruby-lang.org" target="_top">Ruby</a></span></dt><dd><p>Version 1.8 or newer, including header and linkable object files for building extensions, is necessary. You can install Ruby by following <a href="http://www.rubygarden.org/faq/section/show/3" target="_top">these instructions</a>.</p></dd><dt><span class="term"><a href="http://rubyforge.org/frs/?group_id=126" target="_top">RubyGems</a></span></dt><dd><p>Any recent version should be acceptable. You can install RubyGems by following <a href="http://www.rubygems.org/read/chapter/3" target="_top">these instructions</a>.</p></dd></dl></div><div class="section" lang="en" xml:lang="en"><div class="titlepage"><div><div><h3 class="title"><a id="setup.reqs.optional"></a>Recommendations</h3></div></div></div><p>The following software may make your interactions with <span class="application">Ruby-VPI</span> more pleasant.</p><div class="variablelist"><dl><dt><span class="term">Text merging tool</span></dt><dd><p>An <span class="emphasis"><em>interactive</em></span> text merging tool can greatly simplify the process of transferring wanted changes from one file to another. In particular, such tools are especially beneficial when using the <a href="usage.tools.html#usage.tools.generate-test" title="Automated test generation">automated test generator</a>. A handful of the currently available open-source text merging tools are listed below.</p><div class="variablelist"><dl><dt><span class="term"><a href="http://kdiff3.sourceforge.net/" target="_top"><span class="application">kdiff3</span></a></span></dt><dd><p>A graphical, three-way merging tool for KDE.</p></dd><dt><span class="term"><a href="http://meld.sourceforge.net/" target="_top"><span class="application">meld</span></a></span></dt><dd><p>A graphical, three-way merging tool for GNOME.</p></dd><dt><span class="term"><a href="http://tkdiff.sourceforge.net/" target="_top"><span class="application">tkdiff</span></a></span></dt><dd><p>A graphical, two-way merging tool that uses the cross-platform Tk windowing toolkit.</p></dd><dt><span class="term"><a href="http://furius.ca/xxdiff/" target="_top"><span class="application">xxdiff</span></a></span></dt><dd><p>A graphical, three-way merging tool.</p></dd><dt><span class="term"><a href="http://elonen.iki.fi/code/imediff/" target="_top"><span class="application">imediff2</span></a></span></dt><dd><p>A textual, fullscreen two-way merging tool. This tool is useful when you are working remotely via SSH.</p></dd></dl></div></dd></dl></div></div></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="setup.html"><img src="images/prev.png" alt="Prev" /></a> </td><td width="20%" align="center"><a accesskey="u" href="setup.html"><img src="images/up.png" alt="Up" /></a></td><td width="40%" align="right"> <a accesskey="n" href="setup.installation.html"><img src="images/next.png" alt="Next" /></a></td></tr><tr><td width="40%" align="left" valign="top">Chapter 3. Setup </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"> Installation</td></tr></table></div></body></html>
data/doc/src/figures.dia DELETED
Binary file
data/doc/src/license.xml DELETED
@@ -1,446 +0,0 @@
1
- <appendix id="gfdl">
2
- <appendixinfo>
3
- <title>GNU Free Documentation License</title>
4
-
5
- <pubdate>Version 1.2, November 2002</pubdate>
6
- <copyright><year>2000,2001,2002</year>
7
- <holder>Free Software Foundation, Inc.</holder></copyright>
8
- <legalnotice id="gfdl-legalnotice">
9
- <para><address>Free Software Foundation, Inc.
10
- <street>51 Franklin St, Fifth Floor</street>,
11
- <city>Boston</city>,
12
- <state>MA</state>
13
- <postcode>02110-1301</postcode>
14
- <country>USA</country>
15
- </address></para>
16
- <para>Everyone is permitted to copy and distribute verbatim copies
17
- of this license document, but changing it is not allowed.</para>
18
- </legalnotice>
19
- <releaseinfo>Version 1.2, November 2002</releaseinfo>
20
- </appendixinfo>
21
-
22
- <title>GNU Free Documentation License</title>
23
- <section id="gfdl-0"><title>PREAMBLE</title>
24
-
25
- <para>The purpose of this License is to make a manual, textbook, or
26
- other functional and useful document "free" in the sense of freedom: to
27
- assure everyone the effective freedom to copy and redistribute it, with
28
- or without modifying it, either commercially or noncommercially.
29
- Secondarily, this License preserves for the author and publisher a way
30
- to get credit for their work, while not being considered responsible for
31
- modifications made by others.</para>
32
-
33
- <para>This License is a kind of "copyleft", which means that derivative
34
- works of the document must themselves be free in the same sense. It
35
- complements the GNU General Public License, which is a copyleft license
36
- designed for free software.</para>
37
-
38
- <para>We have designed this License in order to use it for manuals for
39
- free software, because free software needs free documentation: a free
40
- program should come with manuals providing the same freedoms that the
41
- software does. But this License is not limited to software manuals; it
42
- can be used for any textual work, regardless of subject matter or
43
- whether it is published as a printed book. We recommend this License
44
- principally for works whose purpose is instruction or reference.</para>
45
- </section>
46
-
47
- <section id="gfdl-1"><title>APPLICABILITY AND DEFINITIONS</title>
48
-
49
- <para id="gfdl-doc">This License applies to any manual or other work, in
50
- any medium, that contains a notice placed by the copyright holder saying
51
- it can be distributed under the terms of this License. Such a notice
52
- grants a world-wide, royalty-free license, unlimited in duration, to use
53
- that work under the conditions stated herein. The "Document", below,
54
- refers to any such manual or work. Any member of the public is a
55
- licensee, and is addressed as "you". You accept the license if you
56
- copy, modify or distribute the work in a way requiring permission under
57
- copyright law.</para>
58
-
59
- <para id="gfdl-mod-ver">A "Modified Version" of the Document means any
60
- work containing the Document or a portion of it, either copied verbatim,
61
- or with modifications and/or translated into another language.</para>
62
-
63
- <para id="gfdl-secnd-sect">A "Secondary Section" is a named appendix or
64
- a front-matter section of the Document that deals exclusively with the
65
- relationship of the publishers or authors of the Document to the
66
- Document's overall subject (or to related matters) and contains nothing
67
- that could fall directly within that overall subject. (Thus, if the
68
- Document is in part a textbook of mathematics, a Secondary Section may
69
- not explain any mathematics.) The relationship could be a matter of
70
- historical connection with the subject or with related matters, or of
71
- legal, commercial, philosophical, ethical or political position
72
- regarding them.</para>
73
-
74
- <para id="gfdl-inv-sect">The "Invariant Sections" are certain Secondary
75
- Sections whose titles are designated, as being those of Invariant
76
- Sections, in the notice that says that the Document is released under
77
- this License. If a section does not fit the above definition of
78
- Secondary then it is not allowed to be designated as Invariant. The
79
- Document may contain zero Invariant Sections. If the Document does not
80
- identify any Invariant Sections then there are none.</para>
81
-
82
- <para id="gfdl-cov-text">The "Cover Texts" are certain short passages of
83
- text that are listed, as Front-Cover Texts or Back-Cover Texts, in the
84
- notice that says that the Document is released under this License. A
85
- Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at
86
- most 25 words.</para>
87
-
88
- <para id="gfdl-transparent">A "Transparent" copy of the Document means a
89
- machine-readable copy, represented in a format whose specification is
90
- available to the general public, that is suitable for revising the
91
- document straightforwardly with generic text editors or (for images
92
- composed of pixels) generic paint programs or (for drawings) some widely
93
- available drawing editor, and that is suitable for input to text
94
- formatters or for automatic translation to a variety of formats suitable
95
- for input to text formatters. A copy made in an otherwise Transparent
96
- file format whose markup, or absence of markup, has been arranged to
97
- thwart or discourage subsequent modification by readers is not
98
- Transparent. An image format is not Transparent if used for any
99
- substantial amount of text. A copy that is not "Transparent" is called
100
- "Opaque".</para>
101
-
102
- <para>Examples of suitable formats for Transparent copies include plain
103
- ASCII without markup, Texinfo input format, LaTeX input format, SGML or
104
- XML using a publicly available DTD, and standard-conforming simple HTML,
105
- PostScript or PDF designed for human modification. Examples of
106
- transparent image formats include PNG, XCF and JPG. Opaque formats
107
- include proprietary formats that can be read and edited only by
108
- proprietary word processors, SGML or XML for which the DTD and/or
109
- processing tools are not generally available, and the machine-generated
110
- HTML, PostScript or PDF produced by some word processors for output
111
- purposes only.</para>
112
-
113
- <para id="gfdl-title-page">The "Title Page" means, for a printed book,
114
- the title page itself, plus such following pages as are needed to hold,
115
- legibly, the material this License requires to appear in the title page.
116
- For works in formats which do not have any title page as such, "Title
117
- Page" means the text near the most prominent appearance of the work's
118
- title, preceding the beginning of the body of the text.</para>
119
-
120
- <para id="gfdl-entitled">A section "Entitled XYZ" means a named subunit
121
- of the Document whose title either is precisely XYZ or contains XYZ in
122
- parentheses following text that translates XYZ in another language.
123
- (Here XYZ stands for a specific section name mentioned below, such as
124
- "Acknowledgements", "Dedications", "Endorsements", or "History".) To
125
- "Preserve the Title" of such a section when you modify the Document
126
- means that it remains a section "Entitled XYZ" according to this
127
- definition.</para>
128
-
129
- <para>The Document may include Warranty Disclaimers next to the notice
130
- which states that this License applies to the Document. These Warranty
131
- Disclaimers are considered to be included by reference in this License,
132
- but only as regards disclaiming warranties: any other implication that
133
- these Warranty Disclaimers may have is void and has no effect on the
134
- meaning of this License.</para>
135
- </section>
136
-
137
- <section id="gfdl-2"><title>VERBATIM COPYING</title>
138
-
139
- <para>You may copy and distribute the Document in any medium, either
140
- commercially or noncommercially, provided that this License, the
141
- copyright notices, and the license notice saying this License applies to
142
- the Document are reproduced in all copies, and that you add no other
143
- conditions whatsoever to those of this License. You may not use
144
- technical measures to obstruct or control the reading or further copying
145
- of the copies you make or distribute. However, you may accept
146
- compensation in exchange for copies. If you distribute a large enough
147
- number of copies you must also follow the conditions in section 3.
148
- </para>
149
-
150
- <para>You may also lend copies, under the same conditions stated above,
151
- and you may publicly display copies.</para>
152
- </section>
153
-
154
- <section id="gfdl-3"><title>COPYING IN QUANTITY</title>
155
-
156
- <para>If you publish printed copies (or copies in media that commonly
157
- have printed covers) of the Document, numbering more than 100, and the
158
- Document's license notice requires Cover Texts, you must enclose the
159
- copies in covers that carry, clearly and legibly, all these Cover Texts:
160
- Front-Cover Texts on the front cover, and Back-Cover Texts on the back
161
- cover. Both covers must also clearly and legibly identify you as the
162
- publisher of these copies. The front cover must present the full title
163
- with all words of the title equally prominent and visible. You may add
164
- other material on the covers in addition. Copying with changes limited
165
- to the covers, as long as they preserve the title of the Document and
166
- satisfy these conditions, can be treated as verbatim copying in other
167
- respects.</para>
168
-
169
- <para>If the required texts for either cover are too voluminous to fit
170
- legibly, you should put the first ones listed (as many as fit
171
- reasonably) on the actual cover, and continue the rest onto adjacent
172
- pages.</para>
173
-
174
- <para>If you publish or distribute Opaque copies of the Document
175
- numbering more than 100, you must either include a machine-readable
176
- Transparent copy along with each Opaque copy, or state in or with each
177
- Opaque copy a computer-network location from which the general
178
- network-using public has access to download using public-standard
179
- network protocols a complete Transparent copy of the Document, free of
180
- added material. If you use the latter option, you must take reasonably
181
- prudent steps, when you begin distribution of Opaque copies in quantity,
182
- to ensure that this Transparent copy will remain thus accessible at the
183
- stated location until at least one year after the last time you
184
- distribute an Opaque copy (directly or through your agents or retailers)
185
- of that edition to the public.</para>
186
-
187
- <para>It is requested, but not required, that you contact the authors of
188
- the Document well before redistributing any large number of copies, to
189
- give them a chance to provide you with an updated version of the
190
- Document.</para>
191
- </section>
192
-
193
- <section id="gfdl-4"><title>MODIFICATIONS</title>
194
-
195
- <para>You may copy and distribute a Modified Version of the Document
196
- under the conditions of sections 2 and 3 above, provided that you
197
- release the Modified Version under precisely this License, with the
198
- Modified Version filling the role of the Document, thus licensing
199
- distribution and modification of the Modified Version to whoever
200
- possesses a copy of it. In addition, you must do these things in the
201
- Modified Version:</para>
202
-
203
- <orderedlist id="gfdl-modif-cond" numeration="upperalpha">
204
- <title>GNU FDL Modification Conditions</title>
205
- <listitem><simpara>Use in the Title Page (and on the covers, if any) a
206
- title distinct from that of the Document, and from those of previous
207
- versions (which should, if there were any, be listed in the History
208
- section of the Document). You may use the same title as a previous
209
- version if the original publisher of that version gives permission.
210
- </simpara></listitem>
211
- <listitem><simpara>List on the Title Page, as authors, one or more
212
- persons or entities responsible for authorship of the modifications in
213
- the Modified Version, together with at least five of the principal
214
- authors of the Document (all of its principal authors, if it has fewer
215
- than five), unless they release you from this requirement.
216
- </simpara></listitem>
217
- <listitem><simpara>State on the Title page the name of the publisher of
218
- the Modified Version, as the publisher.</simpara></listitem>
219
- <listitem><simpara>Preserve all the copyright notices of the Document.
220
- </simpara></listitem>
221
- <listitem><simpara>Add an appropriate copyright notice for your
222
- modifications adjacent to the other copyright notices.
223
- </simpara></listitem>
224
- <listitem><simpara>Include, immediately after the copyright notices, a
225
- license notice giving the public permission to use the Modified
226
- Version under the terms of this License, in the form shown in the
227
- <link linkend="gfdl-addendum">Addendum</link> below.
228
- </simpara></listitem>
229
- <listitem><simpara>Preserve in that license notice the full lists of
230
- Invariant Sections and required Cover Texts given in the Document's
231
- license notice.</simpara></listitem>
232
- <listitem><simpara>Include an unaltered copy of this License.
233
- </simpara></listitem>
234
- <listitem><simpara>Preserve the section Entitled "History", Preserve its
235
- Title, and add to it an item stating at least the title, year, new
236
- authors, and publisher of the Modified Version as given on the Title
237
- Page. If there is no section Entitled "History" in the Document,
238
- create one stating the title, year, authors, and publisher of the
239
- Document as given on its Title Page, then add an item describing the
240
- Modified Version as stated in the previous sentence.
241
- </simpara></listitem>
242
- <listitem><simpara>Preserve the network location, if any, given in the
243
- Document for public access to a Transparent copy of the Document, and
244
- likewise the network locations given in the Document for previous
245
- versions it was based on. These may be placed in the "History"
246
- section. You may omit a network location for a work that was
247
- published at least four years before the Document itself, or if the
248
- original publisher of the version it refers to gives permission.
249
- </simpara></listitem>
250
- <listitem><simpara>For any section Entitled "Acknowledgements" or
251
- "Dedications", Preserve the Title of the section, and preserve in the
252
- section all the substance and tone of each of the contributor
253
- acknowledgements and/or dedications given therein.
254
- </simpara></listitem>
255
- <listitem><simpara>Preserve all the Invariant Sections of the Document,
256
- unaltered in their text and in their titles. Section numbers or the
257
- equivalent are not considered part of the section titles.
258
- </simpara></listitem>
259
- <listitem><simpara>Delete any section Entitled "Endorsements".
260
- Such a section may not be included in the Modified Version.
261
- </simpara></listitem>
262
- <listitem><simpara>Do not retitle any existing section to be Entitled
263
- "Endorsements" or to conflict in title with any Invariant Section.
264
- </simpara></listitem>
265
- <listitem><simpara>Preserve any Warranty Disclaimers.
266
- </simpara></listitem>
267
- </orderedlist>
268
-
269
- <para>If the Modified Version includes new front-matter sections or
270
- appendices that qualify as Secondary Sections and contain no material
271
- copied from the Document, you may at your option designate some or all
272
- of these sections as invariant. To do this, add their titles to the
273
- list of Invariant Sections in the Modified Version's license notice.
274
- These titles must be distinct from any other section titles.</para>
275
-
276
- <para>You may add a section Entitled "Endorsements", provided it
277
- contains nothing but endorsements of your Modified Version by various
278
- parties--for example, statements of peer review or that the text has
279
- been approved by an organization as the authoritative definition of a
280
- standard.</para>
281
-
282
- <para>You may add a passage of up to five words as a Front-Cover Text,
283
- and a passage of up to 25 words as a Back-Cover Text, to the end of the
284
- list of Cover Texts in the Modified Version. Only one passage of
285
- Front-Cover Text and one of Back-Cover Text may be added by (or through
286
- arrangements made by) any one entity. If the Document already includes
287
- a cover text for the same cover, previously added by you or by
288
- arrangement made by the same entity you are acting on behalf of, you may
289
- not add another; but you may replace the old one, on explicit permission
290
- from the previous publisher that added the old one.</para>
291
-
292
- <para>The author(s) and publisher(s) of the Document do not by this
293
- License give permission to use their names for publicity for or to
294
- assert or imply endorsement of any Modified Version.</para>
295
- </section>
296
-
297
- <section id="gfdl-5"><title>COMBINING DOCUMENTS</title>
298
-
299
- <para>You may combine the Document with other documents released under
300
- this License, under the terms defined in <link linkend="gfdl-4">section
301
- 4</link> above for modified versions, provided that you include in the
302
- combination all of the Invariant Sections of all of the original
303
- documents, unmodified, and list them all as Invariant Sections of your
304
- combined work in its license notice, and that you preserve all their
305
- Warranty Disclaimers.</para>
306
-
307
- <para>The combined work need only contain one copy of this License, and
308
- multiple identical Invariant Sections may be replaced with a single
309
- copy. If there are multiple Invariant Sections with the same name but
310
- different contents, make the title of each such section unique by adding
311
- at the end of it, in parentheses, the name of the original author or
312
- publisher of that section if known, or else a unique number. Make the
313
- same adjustment to the section titles in the list of Invariant Sections
314
- in the license notice of the combined work.</para>
315
-
316
- <para>In the combination, you must combine any sections Entitled
317
- "History" in the various original documents, forming one section
318
- Entitled "History"; likewise combine any sections Entitled
319
- "Acknowledgements", and any sections Entitled "Dedications". You must
320
- delete all sections Entitled "Endorsements".</para>
321
- </section>
322
-
323
- <section id="gfdl-6"><title>COLLECTIONS OF DOCUMENTS</title>
324
-
325
- <para>You may make a collection consisting of the Document and other
326
- documents released under this License, and replace the individual copies
327
- of this License in the various documents with a single copy that is
328
- included in the collection, provided that you follow the rules of this
329
- License for verbatim copying of each of the documents in all other
330
- respects.</para>
331
-
332
- <para>You may extract a single document from such a collection, and
333
- distribute it individually under this License, provided you insert a
334
- copy of this License into the extracted document, and follow this
335
- License in all other respects regarding verbatim copying of that
336
- document.</para>
337
- </section>
338
-
339
- <section id="gfdl-7"><title>AGGREGATION WITH INDEPENDENT WORKS</title>
340
-
341
- <para>A compilation of the Document or its derivatives with other
342
- separate and independent documents or works, in or on a volume of a
343
- storage or distribution medium, is called an "aggregate" if the
344
- copyright resulting from the compilation is not used to limit the legal
345
- rights of the compilation's users beyond what the individual works
346
- permit. When the Document is included in an aggregate, this License does
347
- not apply to the other works in the aggregate which are not themselves
348
- derivative works of the Document.</para>
349
-
350
- <para>If the Cover Text requirement of section 3 is applicable to these
351
- copies of the Document, then if the Document is less than one half of
352
- the entire aggregate, the Document's Cover Texts may be placed on covers
353
- that bracket the Document within the aggregate, or the electronic
354
- equivalent of covers if the Document is in electronic form. Otherwise
355
- they must appear on printed covers that bracket the whole
356
- aggregate.</para>
357
- </section>
358
-
359
- <section id="gfdl-8"><title>TRANSLATION</title>
360
-
361
- <para>Translation is considered a kind of modification, so you may
362
- distribute translations of the Document under the terms of section 4.
363
- Replacing Invariant Sections with translations requires special
364
- permission from their copyright holders, but you may include
365
- translations of some or all Invariant Sections in addition to the
366
- original versions of these Invariant Sections. You may include a
367
- translation of this License, and all the license notices in the
368
- Document, and any Warranty Disclaimers, provided that you also include
369
- the original English version of this License and the original versions
370
- of those notices and disclaimers. In case of a disagreement between the
371
- translation and the original version of this License or a notice or
372
- disclaimer, the original version will prevail.</para>
373
-
374
- <para>If a section in the Document is Entitled "Acknowledgements",
375
- "Dedications", or "History", the requirement (section 4) to Preserve its
376
- Title (section 1) will typically require changing the actual
377
- title.</para>
378
- </section>
379
-
380
- <section id="gfdl-9"><title>TERMINATION</title>
381
-
382
- <para>You may not copy, modify, sublicense, or distribute the Document
383
- except as expressly provided for under this License. Any other attempt
384
- to copy, modify, sublicense or distribute the Document is void, and will
385
- automatically terminate your rights under this License. However,
386
- parties who have received copies, or rights, from you under this License
387
- will not have their licenses terminated so long as such parties remain
388
- in full compliance.</para>
389
- </section>
390
-
391
- <section id="gfdl-10"><title>FUTURE REVISIONS OF THIS LICENSE</title>
392
-
393
- <para>The Free Software Foundation may publish new, revised versions of
394
- the GNU Free Documentation License from time to time. Such new versions
395
- will be similar in spirit to the present version, but may differ in
396
- detail to address new problems or concerns. See
397
- http://www.gnu.org/copyleft/.</para>
398
-
399
- <para>Each version of the License is given a distinguishing version
400
- number. If the Document specifies that a particular numbered version of
401
- this License "or any later version" applies to it, you have the option
402
- of following the terms and conditions either of that specified version
403
- or of any later version that has been published (not as a draft) by the
404
- Free Software Foundation. If the Document does not specify a version
405
- number of this License, you may choose any version ever published (not
406
- as a draft) by the Free Software Foundation.</para>
407
- </section>
408
-
409
- <section id="gfdl-addendum"><title>ADDENDUM: How to use this License for
410
- your documents</title>
411
-
412
- <para>To use this License in a document you have written, include a copy
413
- of the License in the document and put the following copyright and
414
- license notices just after the title page:</para>
415
-
416
- <blockquote id="copyright-sample">
417
- <title>Sample Invariant Sections list</title><para>
418
- Copyright (c) YEAR YOUR NAME.
419
- Permission is granted to copy, distribute and/or modify this document
420
- under the terms of the GNU Free Documentation License, Version 1.2
421
- or any later version published by the Free Software Foundation;
422
- with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
423
- A copy of the license is included in the section entitled "GNU
424
- Free Documentation License".
425
- </para></blockquote>
426
-
427
- <para>If you have Invariant Sections, Front-Cover Texts and Back-Cover
428
- Texts, replace the "with...Texts." line with this:</para>
429
-
430
- <blockquote id="inv-cover-sample">
431
- <title>Sample Invariant Sections list</title>
432
- <para>
433
- with the Invariant Sections being LIST THEIR TITLES, with the
434
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
435
- </para></blockquote>
436
-
437
- <para>If you have Invariant Sections without Cover Texts, or some other
438
- combination of the three, merge those two alternatives to suit the
439
- situation.</para>
440
-
441
- <para>If your document contains nontrivial examples of program code, we
442
- recommend releasing these examples in parallel under your choice of free
443
- software license, such as the GNU General Public License, to permit
444
- their use in free software.</para>
445
- </section>
446
- </appendix>