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

SourceInfo: simplify the common case for makeMessage, print it differently #4249

Merged
merged 6 commits into from
Jul 9, 2024

Conversation

mwachs5
Copy link
Contributor

@mwachs5 mwachs5 commented Jul 8, 2024

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

  • API modification

Desired Merge Strategy

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

Release Notes

Add a default to SourceInfo.makeMessage() so that users don't always have to write makeMessage(x => x). Change the toString of SourceLine so that it puts a colon instead of a space between the file name and line number, which makes it possible to click-to-source in editors like VSCode.

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 this to the 7.0 milestone Jul 9, 2024
@mwachs5 mwachs5 marked this pull request as ready for review July 9, 2024 12:05
@mwachs5 mwachs5 changed the title simplify the common case for makeMessage, print it differently SourceInfo: simplify the common case for makeMessage, print it differently Jul 9, 2024
Copy link
Member

@sequencer sequencer left a comment

Choose a reason for hiding this comment

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

LGTM

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!

You have some failing tests though, they look like tests that just need to be updated for the new format:

[info] *** 4 TESTS FAILED ***
[error] Failed tests:
[error] 	chiselTests.experimental.hierarchy.InstantiateSpec
[error] 	chiselTests.WhenSpec
[error] 	chiselTests.simulator.SimulatorSpec

Copy link
Member

@dtzSiFive dtzSiFive left a comment

Choose a reason for hiding this comment

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

LGTM

@mwachs5 mwachs5 enabled auto-merge (squash) July 9, 2024 20:09
@mwachs5 mwachs5 merged commit f62b790 into main Jul 9, 2024
14 checks passed
@mwachs5 mwachs5 deleted the info-make-message branch July 9, 2024 20:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants