luke
/
iverilog
mirror of https://github.com/steveicarus/iverilog.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation to describe the --enable-libveriuser config option. 

Also fix a typo in the --with-valgrind description.
This commit is contained in:
Martin Whitaker 2025-10-25 14:03:00 +01:00
parent d766248bc1
commit b69cb8efda
2 changed files with 25 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
Documentation/developer/getting_started.rst
View File

@ -103,6 +103,22 @@ reference the correct run time files and directories. The run time will check
that it is running a file with a compatible version e.g.(you can not run a that it is running a file with a compatible version e.g.(you can not run a
V0.9 file with the V0.8 run time). V0.9 file with the V0.8 run time).
.. code-block:: none
--enable-libvvp
The vvp progam is built as a small stub linked to a shared library,
libvvp.so, that may be linked with other programs so that they can host
a vvp simulation.
.. code-block:: none
--enable-libveriuser
PLI version 1 (the ACC and TF routines) were deprecated in IEEE 1364-2005.
These are supported in Icarus Verilog by the libveriuser library and cadpli
module. Starting with v13, these will only be built if this option is used.
A debug options is: A debug options is:
.. code-block:: none .. code-block:: none
@ -111,7 +127,7 @@ A debug options is:
This option adds extra memory cleanup code and pool management code to allow This option adds extra memory cleanup code and pool management code to allow
better memory leak checking when valgrind is available. This option is not better memory leak checking when valgrind is available. This option is not
need when checking for basic errors with valgrind. needed when checking for basic errors with valgrind.
Compiling on Linux Compiling on Linux
------------------ ------------------
@ -222,4 +238,3 @@ or the version branch that you are working on. Your pull request will be run
through continuous integration, and reviewed by one of the main through continuous integration, and reviewed by one of the main
authors. Feedback may be offered to your PR, and once accepted, an approved authors. Feedback may be offered to your PR, and once accepted, an approved
individual will merge it for you. Then you are done. individual will merge it for you. Then you are done.

10
Documentation/usage/installation.rst
View File

@ -99,13 +99,19 @@ time). ::
This option adds extra memory cleanup code and pool management code to allow This option adds extra memory cleanup code and pool management code to allow
better memory leak checking when valgrind is available. This option is not better memory leak checking when valgrind is available. This option is not
need when checking for basic errors with valgrind. :: needed when checking for basic errors with valgrind. ::
--enable-libvvp --enable-libvvp
The vvp progam is built as a small stub linked to a shared library, The vvp progam is built as a small stub linked to a shared library,
libvvp.so, that may be linked with other programs so that they can host libvvp.so, that may be linked with other programs so that they can host
a vvp simulation. a vvp simulation. ::
--enable-libveriuser
PLI version 1 (the ACC and TF routines) were deprecated in IEEE 1364-2005.
These are supported in Icarus Verilog by the libveriuser library and cadpli
module. Starting with v13, these will only be built if this option is used.
Compiling on Linux/Unix Compiling on Linux/Unix
----------------------- -----------------------