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

Remove TransitName and code used only by it #2604

Merged
merged 14 commits into from
Jun 27, 2022
Merged

Conversation

mwachs5
Copy link
Contributor

@mwachs5 mwachs5 commented Jun 26, 2022

Contributor Checklist

  • [N/A] Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • [N/A] Did you add appropriate documentation in docs/src?
  • Did you state the API impact?
  • Did you specify the code generation impact?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • code cleanup

API Impact

This removes the TransitName api deprecated in #2603. Should be merged after that one.
It also uses the naming plugin aPIs to get "good" names in the two usages of the TransitName API. It also "garbage collects" the hook related code that was only there for usage by TransitName.

Backend Code Generation Impact

This will change the generated verilog for Queue.apply() and Pipe.apply, the only usages of TransitName in the codebase. I added unit tests that the names are still "good" and in fact much better than they were before IMHO.

For example you can see the before (07495d5#diff-8dd923d131a5cad79defd56265f33df9037ac4e5169a46f4933f5a66935a7637R150 and after:08cd4c2 for Pipe:

Desired Merge Strategy

  • Squash: The PR will be squashed and merged (choose this if you have no preference.

Release Notes

Remove TransitName API and code only used by it.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels?
  • Did you mark the proper milestone (Bug fix: 3.4.x, [small] API extension: 3.5.x, API modification or big change: 3.6.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@mwachs5 mwachs5 added this to the 3.6.0 milestone Jun 26, 2022
@mwachs5 mwachs5 requested review from azidar and jackkoenig June 26, 2022 03:51
@mwachs5 mwachs5 mentioned this pull request Jun 27, 2022
14 tasks
@mwachs5 mwachs5 force-pushed the remove-transit-name branch from ab8b1aa to a1c5bbf Compare June 27, 2022 17:08
Copy link
Member

@seldridge seldridge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm super happy to see this gone! 💯

@mwachs5 mwachs5 merged commit a134e03 into master Jun 27, 2022
@mwachs5 mwachs5 deleted the remove-transit-name branch June 27, 2022 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants