-A current limitation is having to deal with signal names instead of
-Signals themselves. Also, direct use of vcd.gtkw is a bit verbose. I
-intend to work a bit on this, next.
-
-Possibly, I'll propose and contribute back improvements to the nMigen
-sim.pysim.Simulator.write_vcd method, which was my inspiration for this
-work.
-
-A more complete description follows:
-
-https://git.libre-soc.org/?p=soc.git;a=commitdiff;h=de64658d0a482f1d6df3c84b4087864ff65ccfef
-
-commit de64658d0a482f1d6df3c84b4087864ff65ccfef
-Author: Cesar Strauss <cestrauss@gmail.com>
-Date: Thu Aug 13 19:40:35 2020 -0300
-
- Demonstrates creating stylish GTKWave "save" files from python
-
- This is inspired on the use of the vcd.gtkw module in nMigen, used
- internally to create "save" files of selected Signals, for
- "Simulator.write_vcd".
-
- However, the vcd.gtkw module exposes a great deal of extra
- possibilities, like:
-
- 1) Individual trace colors.
- For instance, use different color styles for input, output, debug
- and internal traces.
- 2) Numeric bases besides the default hex.
- 3) Collapsible trace groups
- Useful to hide and show, at once, groups of debug, internal and
- sub-module traces.
- Select the opening or closing brace, then use the T key.
- 4) Comments in the signal names pane
- 5) Change the displayed name of a trace
- 6) Sane default for initial zoom level
- 7) Place markers on interesting places
- 8) Put the generating file name as a comment in the file
+This tutorial is about generating better GTKWave documents (*.gtkw)
+from Python. The goal is to ease analysis of traces generated by
+unit-tests, and at the same time to better understand the inner working
+of modules, for which we are writing such tests.