aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJonas Baggett <jonas17b@gmail.com>2016-11-01 19:23:38 +0100
committertgingold <tgingold@users.noreply.github.com>2016-11-01 19:23:38 +0100
commitb869a4acb52358fe8ca5decaac826af056bfdfca (patch)
treebf9f65e7be9f06ab401e5f23f22194846aa1c389 /doc
parentdc6a82418653ce5b732d2bc26b393d3259fd93d5 (diff)
downloadghdl-b869a4acb52358fe8ca5decaac826af056bfdfca.tar.gz
ghdl-b869a4acb52358fe8ca5decaac826af056bfdfca.tar.bz2
ghdl-b869a4acb52358fe8ca5decaac826af056bfdfca.zip
There is a new --write-opt-file option that will create a wave option file with all the signals of the design. (#179)
The --wave-opt-file option is renamed to --read-opt-file for consistency Some code cleanup and bug fixes
Diffstat (limited to 'doc')
-rw-r--r--doc/Simulation_and_runtime.rst19
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/Simulation_and_runtime.rst b/doc/Simulation_and_runtime.rst
index 979a9892a..518c8a290 100644
--- a/doc/Simulation_and_runtime.rst
+++ b/doc/Simulation_and_runtime.rst
@@ -118,11 +118,28 @@ all options available, including the debugging one.
Disable buffering on stdout, stderr and files opened in write or append mode (TEXTIO).
-.. option:: --wave-opt-file=<FILENAME>
+.. option:: --read-opt-file=<FILENAME>
Filter signals to be dumped to the wave file according to the wave option
file provided.
+ Here is a description of the wave option file format :
+
+ $ version = 1.0 # Optional
+
+ # Signals in packages :
+ my_pkg.global_signal_a
+
+ # Signals in entities :
+ /top/sub/clk
+
+
+.. option:: --write-opt-file=<FILENAME>
+
+ If the wave option file doesn't exist, creates it with all the signals of
+ the design. Otherwise throws an error, because it won't erase an existing
+ file.
+
.. option:: --vcd=<FILENAME>