Add API to include comments in the FIRRTL #4949
Merged
+132
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This is useful for debugging complex generators
seldridge
approved these changes
Jun 8, 2025
There was a problem hiding this comment.
Nice. This seems useful for debugging generators.
In the future, I'm very open to figuring out how to have comments that are preserved to Verilog. This is a different beast, though.
Also in the future, consider an option that completely disables all comment emission from Chisel. This is an API which can cause problems for build caching depending on how people start to use this.
Comment on lines
+303
to
+310
| while ({ | ||
| val line = it.next() | ||
| b ++= "; "; b ++= line | ||
| if (it.hasNext) { | ||
| newLineAndIndent() | ||
| } | ||
| it.hasNext | ||
| }) () |
There was a problem hiding this comment.
I know this is the correct approach given that Scala dropped do--while. It still looks weird to me, though... 🫠
There was a problem hiding this comment.
I don't love it but it is the most direct way to write this and I do prefer it to duplicating logic for first line vs. the rest 🤷♂️
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I was working on something complicated and this would help a lot with development.
Contributor Checklist
docs/src?Type of Improvement
Desired Merge Strategy
Release Notes
This is for debugging generated FIRRTL only--comments are ignored by the FIRRTL compiler.
Reviewer Checklist (only modified by reviewer)
3.6.x,5.x, or6.xdepending on impact, API modification or big change:7.0)?Enable auto-merge (squash)and clean up the commit message.Create a merge commit.