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.

Sign up for GitHub

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

Jump to bottom

Make requireTypeEquivalent public and add context message #4243

Merged
merged 5 commits into from
Jul 8, 2024
Merged

Make requireTypeEquivalent public and add context message #4243

merged 5 commits into from
Jul 8, 2024

Conversation

mwachs5
Copy link
Contributor

@mwachs5 mwachs5 commented Jul 3, 2024 •
edited
Loading

Contributor Checklist

  • 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?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Feature (or new API)

Desired Merge Strategy

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

Release Notes

Make Add a contextual message to Data.requireTypeEquivalent and expose a public API in DataMirror.requireTypeEquivalent, to make it easier for user code to have good error messages when requiring type equivalence between two chisel Datas

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.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 the Feature New feature, will be included in release notes label Jul 3, 2024
@mwachs5 mwachs5 added this to the 6.x milestone Jul 3, 2024
@mwachs5 mwachs5 requested review from dtzSiFive and jackkoenig July 3, 2024 18:02
jackkoenig
jackkoenig approved these changes Jul 8, 2024
View reviewed changes
Copy link
Contributor

@jackkoenig jackkoenig left a comment

Choose a reason for hiding this comment

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

LGTM, consider adding 1 additional tests but not required

src/test/scala/chisel3/TypeEquivalenceSpec.scala Outdated Show resolved Hide resolved
@mwachs5 mwachs5 enabled auto-merge (squash) July 8, 2024 17:36
@mwachs5 mwachs5 merged commit c324ac5 into main Jul 8, 2024
15 checks passed
@mwachs5 mwachs5 deleted the require-type-equivalent-public branch July 8, 2024 17:40
@mergify mergify bot added the Backported This PR has been backported label Jul 8, 2024
mergify bot pushed a commit that referenced this pull request Jul 8, 2024
@mwachs5 @mergify
Make requireTypeEquivalent public and add context message (#4243)
a6cb496 
* make requireTypeEquivalent public via DataMirror and add a message
* add test cases

(cherry picked from commit c324ac5)
@mergify mergify bot mentioned this pull request Jul 8, 2024
Merged
14 tasks
chiselbot pushed a commit that referenced this pull request Jul 8, 2024
@mergify @mwachs5
Make requireTypeEquivalent public and add context message (#4243) (#4247
e52eccc 
)

* make requireTypeEquivalent public via DataMirror and add a message
* add test cases

(cherry picked from commit c324ac5)

Co-authored-by: Megan Wachs <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jackkoenig jackkoenig jackkoenig approved these changes

@dtzSiFive dtzSiFive Awaiting requested review from dtzSiFive

Assignees
No one assigned
Labels
Backported This PR has been backported Feature New feature, will be included in release notes
Projects
None yet
Milestone
6.x
Development

Successfully merging this pull request may close these issues.
2 participants
@mwachs5 @jackkoenig