diff options
Diffstat (limited to 'doc/using/Simulation.rst')
| -rw-r--r-- | doc/using/Simulation.rst | 36 |
1 files changed, 21 insertions, 15 deletions
diff --git a/doc/using/Simulation.rst b/doc/using/Simulation.rst index 74fd5c89d..e97212375 100644 --- a/doc/using/Simulation.rst +++ b/doc/using/Simulation.rst @@ -1,30 +1,34 @@ .. program:: ghdl .. _USING:Simulation: -Simulation and runtime -###################### +Simulation (runtime) +#################### .. _simulation_options: Simulation options ================== -In most system environments, it is possible to pass options while +In most system environments, it is possible to pass CLI options while invoking a program. Contrary to most programming languages, there is no standard method in VHDL to obtain the arguments or to set the exit status. +However, the GHDL runtime behaviour can be modified with some options: -However, the GHDL runtime behaviour can be modified with some options. For -example, it is possible to pass parameters to your design through the generic -interfaces of the top entity. It is also possible to stop simulation after a -certain time. - -The exit status of the simulation is ``EXIT_SUCCESS`` (0) if the -simulation completes, or ``EXIT_FAILURE`` (1) in case of error -(assertion failure, overflow or any constraint error). +- It is possible to pass parameters to your design through the generic + interfaces of the top entity. +- It is also possible to stop simulation after a certain time. The exit + status of the simulation is ``EXIT_SUCCESS`` (``0``) if the simulation + completes, or ``EXIT_FAILURE`` (``1``) in case of error (assertion + failure, overflow or any constraint error). Here is the list of the most useful options. For further info, see :ref:`DEV:Debugging`. +.. HINT:: + Note that these arguments are represented as ``simulation_options...`` in this documentation. + For analysis/elaboration options, see :ref:`USING:Invoking`. + + .. option:: -gGENERIC=VALUE Set value `VALUE` to generic with name `GENERIC`. @@ -129,6 +133,12 @@ Here is the list of the most useful options. For further info, see :ref:`DEV:Deb Display a short description of the options accepted by the runtime library. +.. option:: --no-run + + Stop the simulation before the first cycle. This option actually elaborates the design, so it will catch any bound error in port maps. See also :option:`-e`. + + This may be used with :option:`--disp-tree` to display the tree without simulating the whole design. + .. _export_waves: Export waveforms @@ -264,10 +274,6 @@ Export hierarchy and references If `KIND` is not specified, the hierarchy is displayed with the ``port`` mode. -.. option:: --no-run - - Stop the simulation before the first cycle. This may be used with :option:`--disp-tree` to display the tree without simulating the whole design. This option actually elaborates the design, so it will catch any bound error in port maps. - .. option:: --xref-html [options] files... To easily navigate through your sources, you may generate cross-references. This command generates an html file for |