diff options
| author | umarcor <unai.martinezcorral@ehu.eus> | 2020-05-08 11:27:01 +0200 |
|---|---|---|
| committer | tgingold <tgingold@users.noreply.github.com> | 2020-05-08 17:40:30 +0200 |
| commit | e9af7ee91e07dcaf12975298172c01699f5c1329 (patch) | |
| tree | 1533a098faea8d30583de7c343d4c2508f431fe1 /doc | |
| parent | bfa1576196ce238c6015bad67aef925a95ecfc53 (diff) | |
| download | ghdl-e9af7ee91e07dcaf12975298172c01699f5c1329.tar.gz ghdl-e9af7ee91e07dcaf12975298172c01699f5c1329.tar.bz2 ghdl-e9af7ee91e07dcaf12975298172c01699f5c1329.zip | |
doc: document option '--time-resolution'
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/using/InvokingGHDL.rst | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/using/InvokingGHDL.rst b/doc/using/InvokingGHDL.rst index 808e26013..918acacfd 100644 --- a/doc/using/InvokingGHDL.rst +++ b/doc/using/InvokingGHDL.rst @@ -371,6 +371,18 @@ Options All the commands that perform a link (:option:`-e`, :option:`--elab-run`, :option:`--link`, :option:`-c`, :option:`-m`, etc.) support overriding the location and name of the generated artifact. +.. option:: --time-resolution=<UNIT> + + Set the base time resolution of the simulation. This option is supported in commands :option:`-a` and :option:`-r` only. + Allowed values are ``auto`` (default with *mcode*), ``fs`` (default with LLVM/GCC), ``ps``, ``ns``, ``us``, ``ms`` or ``sec``. + + .. HINT:: + When overriding the time resolution, all the time units that are used in the design must be larger. Using units below + the resolution will produce a failure. + + .. ATTENTION:: + This feature is supported with *mcode* backend only. It is not possible to support it with either LLVM or GCC backends, + because it needs to apply globally. Warnings ======== |