From b0de47733bf9ee5690fb2bcad919d8d92431b026 Mon Sep 17 00:00:00 2001 From: Tristan Gingold Date: Mon, 1 Jun 2020 22:05:01 +0200 Subject: grt: add and document option --asserts --- doc/using/Simulation.rst | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) (limited to 'doc/using') diff --git a/doc/using/Simulation.rst b/doc/using/Simulation.rst index e90d061b3..607227042 100644 --- a/doc/using/Simulation.rst +++ b/doc/using/Simulation.rst @@ -77,15 +77,21 @@ Here is the list of the most useful options. For further info, see :ref:`DEV:Deb useful. .. option:: --ieee-asserts= +.. option:: --asserts= - Select how the assertions from ``ieee`` units are - handled. `POLICY` can be ``enable`` (the default), - ``disable`` which disables all assertions from ``ieee`` packages - and ``disable-at-0`` which disables only at the start of simulation. + Select how assertions are handled. `POLICY` can be ``enable`` (the + default), ``disable`` which disables all assertions and + ``disable-at-0`` which disables only at the start of simulation. - This option can be useful to avoid assertion messages from + The ``--ieee-asserts`` applies only to assertions from ``ieee`` + package. This option can be useful to avoid assertion messages from ``ieee.numeric_std`` (and other ``ieee`` packages). + The ``--asserts`` option applies to all assertions, including those + from the ``ieee`` units. The behaviour of the latter can be + overridden by using the ``--ieee-asserts`` option after the + ``--asserts`` option. + .. option:: --stop-time=