-
Notifications
You must be signed in to change notification settings - Fork 7
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
A basic file describing how to get started working on Silver #458
base: develop
Are you sure you want to change the base?
Conversation
My vote is that this sort of documentation belongs on the website - there is already some similar (and largely duplicated) info at http://melt.cs.umn.edu/silver/dev/. But we should definitely add a link to this from the Silver README.md file. |
|
||
### `self-compile` | ||
|
||
The `self-compile` script does a simple build of Silver to create a |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note that this doesn't write to jars, but sticks in in build; cp build/silver.compiler.composed.Default.jar jars/silver.compiler.composed.Default.jar
may be necessary
A good way to see where something (e.g. a function) is used in the | ||
Silver code base is to use the following command: | ||
``` | ||
grep -r --include="*.sv" "function name" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I typically just use git grep functionName
as that is quicker to type (and also shows up references in the java runtime.)
Also there are some similar tools under support/bin/scripts
.
you to get new jars using this script. If you have pulled the | ||
`develop` branch and it won't build, run this. | ||
|
||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
note that if a new-jars
PR was just merged and jenkins hasn't finished rebuilding develop
after the merge, this is likely to not work as expected
It is also good to periodically run |
If it does live on the website then there should be something in Git repo that points to this information on the webpage. |
We need a way to introduce new students to the logistics of developing the Silver system. My hope is that this document will be something we can tell new students to read before they start working on the Silver system, and which can be referenced for some questions that might come up as they work.
I don't know if this document belongs in the Silver repository or if it should live somewhere else.
I'm hoping everyone will read this and either add their own text or suggest concepts that need to be added. This includes people who have been working on Silver for a long time, and people who are just starting out and have their questions fresh in their minds.
A couple of notes: