Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
I've updated the BUGS section of the Verilator user guide based on my recent experiences, to help those writing tests for the first time.
I'm not sure I have everything correct, or even whether this level of detail really belongs in the Internals manual.
I've pushed these changes on GitHub. Please pull from https://github.com/jeremybennett/verilator/tree/test-documentation, commit 2f40448f1d6540221f015a6cc1d90faa4ff12b59.
(GitHub really assumes you are pulling between repositories on GitHub. I'm not sure how I should properly structure a pull request to an external repository like Verilator).
Original Redmine Comment
Committed. Bonus points for writing documentation!
I think I'd like to leave the main documentation to focus on what the average user needs to run, so I left the intro information you added. The other stuff could be either internals or added to the driver script. The driver script seemed a better spot as it's much closer to the relevant source so I put it there.