CIF simulator trace input mode documentation is not clear enough
I'm getting a lot of questions about this one right now, from people trying to use it. I'll try to summarize the issues:
- There is no example. Adding one to the documentation would help a lot. Maybe even a few examples, with different options values, to explain the differences. I've made a first start: tank_example_trace_input.zip
- We explain the commands, but there is no general introduction before. Hence, people get lost in the details, especially with respect to whether time may pass or not.
- The
option NAME VALUE
syntax was considered confusing, as it was assumed thatNAME
, because it is capitalized, required a capitalized option name. Lateroption strict on/off
is mentioned, but this was not clear enough. - It was not clear whether it should be
transition event <some_name>
orevent <some_name>
as for options it is alsooption <option_name> <option_value>
(starting withoption
), and the 'Option commands' and 'Transition commands' sections have similar headers. - The trace input mode page doesn't link to the 'Trace input' page, where it is explained how to enable the trace input mode. Hence, users did not know how to enable it.
I don't see all the confusions personally. I'm just relaying what I get from our users. I haven't found any errors in the documentation based on this, but given all the questions, it seems the clarity can be improved.
Edited by Dennis Hendriks