bug 1034: making room for crfbinlog/crfternlogi/crbinlog/crternlogi

[libreriscv.git] / docs / gtkwave_tutorial.mdwn

diff --git a/docs/gtkwave_tutorial.mdwn b/docs/gtkwave_tutorial.mdwn
index 4b1b147cb202c0364dafa73c64aaab0bab39a7f8..d2832e3787dc9767df489b6a40aa49bd23048394 100644 (file)
--- a/docs/gtkwave_tutorial.mdwn
+++ b/docs/gtkwave_tutorial.mdwn
@@ -50,11 +50,11 @@ For example:
     traces = [
         'clk',
         # prev port
-        'op__sdir', 'p_data_i[7:0]', 'p_shift_i[7:0]', 'p_valid_i', 'p_ready_o',
+        'op__sdir', 'p_i_data[7:0]', 'p_i_shift[7:0]', 'p_i_valid', 'p_o_ready',
         # internal signals
         'fsm_state', 'count[3:0]', 'shift_reg[7:0]',
         # next port
-        'n_data_o[7:0]', 'n_valid_o', 'n_ready_i'
+        'n_o_data[7:0]', 'n_o_valid', 'n_i_ready'
     ]
 
 Now, create the document:
@@ -77,7 +77,7 @@ Notice:
 1. No need to press the "zoom to fit" button. The default zoom level is
 adequate for a 1 MHz clock.
 2. If you made a mistake, there will be no warning. The trace will
-simply not appear
+simply not appear (*the properties of the dropped trace will be given to the next signal, be careful*)
 3. The reload button will only reload the VCD file, not the GTKW document. If you regenerate the document, you need to close and open a
 new tab, or exit GTKWave and run again: ``gtkwave simple.gtkw``
 4. If you feel tired of seeing the GTKWave splash window every time,
@@ -133,18 +133,18 @@ Let's add more color:
         'clk',
         # prev port
         ('op__sdir', 'in'),
-        ('p_data_i[7:0]', 'in'),
-        ('p_shift_i[7:0]', 'in'),
-        ('p_valid_i', 'in'),
-        ('p_ready_o', 'out'),
+        ('p_i_data[7:0]', 'in'),
+        ('p_i_shift[7:0]', 'in'),
+        ('p_i_valid', 'in'),
+        ('p_o_ready', 'out'),
         # internal signals
         'fsm_state',
         'count[3:0]',
         'shift_reg[7:0]',
         # next port
-        ('n_data_o[7:0]', 'out'),
-        ('n_valid_o', 'out'),
-        ('n_ready_i', 'in'),
+        ('n_o_data[7:0]', 'out'),
+        ('n_o_valid', 'out'),
+        ('n_i_ready', 'in'),
     ]
 
 Then