aboutsummaryrefslogtreecommitdiffstats
path: root/doc/using
diff options
context:
space:
mode:
authorMarlon James <marlon.james@gmail.com>2021-03-01 12:44:02 -0800
committertgingold <tgingold@users.noreply.github.com>2021-03-02 07:50:54 +0100
commita03aedddf650f923b06ebacb441a713930cd63e1 (patch)
tree13056350de2379e39802cda292c7bc023779c67f /doc/using
parentf5e3ef10265440a3efc95281fef295cba6aab8a9 (diff)
downloadghdl-a03aedddf650f923b06ebacb441a713930cd63e1.tar.gz
ghdl-a03aedddf650f923b06ebacb441a713930cd63e1.tar.bz2
ghdl-a03aedddf650f923b06ebacb441a713930cd63e1.zip
VPI: support loading multiple libraries
Diffstat (limited to 'doc/using')
-rw-r--r--doc/using/Simulation.rst17
1 files changed, 11 insertions, 6 deletions
diff --git a/doc/using/Simulation.rst b/doc/using/Simulation.rst
index 607227042..807a634e2 100644
--- a/doc/using/Simulation.rst
+++ b/doc/using/Simulation.rst
@@ -146,15 +146,20 @@ Here is the list of the most useful options. For further info, see :ref:`DEV:Deb
.. option:: --vpi=<FILENAME>
- Load VPI module.
+ Load VPI library. This option can be used multiple times to load different libraries.
- .. HINT::
- Currently, although multiple ``--vpi=`` options can be passed, only the last one is kept/used. However, handling
- more than one shouldn't be a difficult change.
+ Any registration functions in the ``vlog_startup_routines`` array in the library will be called:
+
+ .. code-block:: c
+
+ void (*vlog_startup_routines[]) () = {
+ my_handle_register,
+ 0
+ };
-.. option:: --vpi-trace=<FILE>
+.. option:: --vpi-trace[=<FILENAME>]
- Trace vpi calls to FILE.
+ Trace vpi calls. Trace is printed to :file:`FILENAME` if provided, otherwise to stdout.
.. option:: --help