Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updates to the internal documentation #554

Closed
veripoolbot opened this issue Aug 25, 2012 · 2 comments
Closed

Updates to the internal documentation #554

veripoolbot opened this issue Aug 25, 2012 · 2 comments

Comments

@veripoolbot
Copy link

@veripoolbot veripoolbot commented Aug 25, 2012


Author Name: Jeremy Bennett (@jeremybennett)
Original Redmine Issue: 554 from https://www.veripool.org
Original Date: 2012-08-25
Original Assignee: Jeremy Bennett (@jeremybennett)


I've updated the internal documentation.

  • Added documentation of Graph classes to Key Classes section.
  • Updated TESTING section with advice on configuring with @--enable-longtests@ @--enable-ccwarn@, additional prerequisites and traps to avoid.
  • Moved "ADDING A NEW FEATURE" to the end of the document and added a sub-section on creating a new pass.

The rationale for the last of these is that to add a new feature you need to have read most of the preceding sections.

Please pull a patch for this from branch internals-doc at git://github.com/jeremybennett/verilator.git.

@veripoolbot

This comment has been minimized.

Copy link
Author

@veripoolbot veripoolbot commented Aug 25, 2012


Original Redmine Comment
Author Name: Wilson Snyder (@wsnyder)
Original Date: 2012-08-25T16:48:49Z


Thanks, fixed in git towards 3.841.

BTW I got a bit confused by the internal-doc branch vs internals-doc branch, you might want to remove both now.

@veripoolbot

This comment has been minimized.

Copy link
Author

@veripoolbot veripoolbot commented Aug 27, 2012


Original Redmine Comment
Author Name: Jeremy Bennett (@jeremybennett)
Original Date: 2012-08-27T16:04:57Z


Thanks - all obsolete branches removed from GitHub. All that remains is stuff I'm working on - watch this space :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
1 participant
You can’t perform that action at this time.