Support added for * and **. Please note that wildcards inside names like /top/sub*/... are not supported yet, only synthax like /top/*/... works for now. Support for wildcards inside names will be added on version 1.2, at the same time as simple regexp support.

Current version set to 1.1

1 files changed, 22 insertions, 4 deletions

diff --git a/doc/Simulation_and_runtime.rst b/doc/Simulation_and_runtime.rst
index 518c8a290..25a779fb2 100644
--- a/doc/Simulation_and_runtime.rst
+++ b/doc/Simulation_and_runtime.rst
@@ -123,16 +123,34 @@ all options available, including the debugging one.
   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 :
+  Here is a description of the wave option file format currently supported :
 
-     $ version = 1.0  # Optional
+     $ version = 1.1  # Optional
 
-     # Signals in packages :
+     # Path format for signals in packages :
      my_pkg.global_signal_a
 
-     # Signals in entities :
+     # Path format for signals in entities :
      /top/sub/clk
 
+     # Dumps every signals named reset in first level sub entities of top
+     /top/*/reset
+
+     # Dumps every signals named reset in recursive sub entities of top
+     /top/**/reset
+
+     # Dump every signals of sub2 which could be anywhere in design except on
+     # top level
+     /**/sub2/*
+
+     # Dump every signals of sub3 which must be a first level sub entity of the
+     # top level
+     /*/sub3/*
+
+     # Dump every signals of the first level sub entities of sub3 (but not
+     # those of sub3)
+     /**/sub3/*/*
+
 
 .. option:: --write-opt-file=<FILENAME>