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

Report source locator in when scoping error messages #3804

Merged
merged 1 commit into from
Feb 1, 2024

Conversation

jackkoenig
Copy link
Contributor

Not really a bugfix but that seemed closest

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

  • Bugfix

Desired Merge Strategy

  • Squash

Release Notes

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.

@jackkoenig jackkoenig added the Bugfix Fixes a bug, will be included in release notes label Jan 31, 2024
@jackkoenig jackkoenig added this to the 3.6.x milestone Jan 31, 2024
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.

Code looks good and this is definitely an improvement.

This hints at missing infrastructure for pretty printing multiple source locators. E.g., it would be useful if after doing one line-carat error pointing at one bad operation, you could then show the when that it escaped from. Just showing a bare source locator is better.

Something like attachNote (https://mlir.llvm.org/docs/Diagnostics/#attaching-notes) is what is ideal.

@jackkoenig
Copy link
Contributor Author

This hints at missing infrastructure for pretty printing multiple source locators. E.g., it would be useful if after doing one line-carat error pointing at one bad operation, you could then show the when that it escaped from. Just showing a bare source locator is better.

Yeah definitely. I thought about trying to tackle that when I was making that changed but just went with the smaller touch. These errors could also be changed to be non-fatal (report error rather than throwing exception).

@jackkoenig jackkoenig force-pushed the better-when-scope-error-messages branch from afd72d5 to d7d9287 Compare February 1, 2024 05:12
@jackkoenig
Copy link
Contributor Author

It also would be super nice to have the source locator for where the current data was bound (eg. where the Wire was created). That's not currently very easy to figure out, but would definitely help improve this sort of error reporting quite a bit.

@jackkoenig jackkoenig enabled auto-merge (squash) February 1, 2024 05:13
@jackkoenig jackkoenig merged commit d21a663 into main Feb 1, 2024
13 checks passed
@jackkoenig jackkoenig deleted the better-when-scope-error-messages branch February 1, 2024 05:27
@mergify mergify bot added the Backported This PR has been backported label Feb 1, 2024
mergify bot pushed a commit that referenced this pull request Feb 1, 2024
(cherry picked from commit d21a663)

# Conflicts:
#	core/src/main/scala/chisel3/Data.scala
mergify bot pushed a commit that referenced this pull request Feb 1, 2024
(cherry picked from commit d21a663)

# Conflicts:
#	core/src/main/scala/chisel3/Data.scala
mergify bot pushed a commit that referenced this pull request Feb 1, 2024
chiselbot pushed a commit that referenced this pull request Feb 1, 2024
(cherry picked from commit d21a663)

Co-authored-by: Jack Koenig <koenig@sifive.com>
chiselbot pushed a commit that referenced this pull request Feb 1, 2024
…#3807)

* Report source locator in when scoping error messages (#3804)

(cherry picked from commit d21a663)

# Conflicts:
#	core/src/main/scala/chisel3/Data.scala

* resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
chiselbot pushed a commit that referenced this pull request Feb 1, 2024
…#3806)

* Report source locator in when scoping error messages (#3804)

(cherry picked from commit d21a663)

# Conflicts:
#	core/src/main/scala/chisel3/Data.scala

* resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants