From b69cb8efdac60a068930c9b7e885235acad4dfa8 Mon Sep 17 00:00:00 2001 From: Martin Whitaker Date: Sat, 25 Oct 2025 14:03:00 +0100 Subject: [PATCH] Update documentation to describe the --enable-libveriuser config option. Also fix a typo in the --with-valgrind description. --- Documentation/developer/getting_started.rst | 19 +++++++++++++++++-- Documentation/usage/installation.rst | 10 ++++++++-- 2 files changed, 25 insertions(+), 4 deletions(-) diff --git a/Documentation/developer/getting_started.rst b/Documentation/developer/getting_started.rst index c13cae026..73f10ac83 100644 --- a/Documentation/developer/getting_started.rst +++ b/Documentation/developer/getting_started.rst @@ -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 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: .. code-block:: none @@ -111,7 +127,7 @@ A debug options is: 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 -need when checking for basic errors with valgrind. +needed when checking for basic errors with valgrind. 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 authors. Feedback may be offered to your PR, and once accepted, an approved individual will merge it for you. Then you are done. - diff --git a/Documentation/usage/installation.rst b/Documentation/usage/installation.rst index 46ad5bcf1..610184db2 100644 --- a/Documentation/usage/installation.rst +++ b/Documentation/usage/installation.rst @@ -99,13 +99,19 @@ time). :: 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 -need when checking for basic errors with valgrind. :: +needed when checking for basic errors with valgrind. :: --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. +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 -----------------------