Add --warn:reflective-naming #2561
Merged
Conversation
This file contains 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
16 tasks
mwachs5
reviewed
Jun 4, 2022
| case _ => false | ||
| } | ||
| case b: BaseModule => true | ||
| case m: Mem[_] => true |
There was a problem hiding this comment.
does this need a _ default case? What about Verification statements?
There was a problem hiding this comment.
Yes and yes, will fix and add tests
mwachs5
reviewed
Jun 4, 2022
| * @param seed The seed for computing the name (if available) | ||
| * @param defaultPrefix Optional default prefix which is only used if the seed is not defined | ||
| * @param defaultSeed Optional default (or "fallback") seed | ||
| * @return the name, if it can be computed |
There was a problem hiding this comment.
is it None if it cannot be computed? Under what scenarios can it not be computed?
There was a problem hiding this comment.
It can't be computed if seed and default seed are both None.
mwachs5
reviewed
Jun 4, 2022
mwachs5
reviewed
Jun 4, 2022
jackkoenig
force-pushed
the
warn-on-reflective-naming
branch
from
2e3dcbe
to
82e5ebb
Compare
The new function is chisel3.internal.buildName.
jackkoenig
force-pushed
the
warn-on-reflective-naming
branch
from
82e5ebb
to
c74f564
Compare
|
Forgot to run scalafmt and forgot to add a test for |
This new argument (and associated annotation) will turn on a warning whenever reflective naming changes the name of a signal. This is provided to help migrate from Chisel 3.5 to 3.6 since reflective naming is removed in Chisel 3.6.
jackkoenig
force-pushed
the
warn-on-reflective-naming
branch
from
c74f564
to
97afd9b
Compare
mergify bot
added a commit
that referenced
this pull request
Jun 6, 2022
* Factor buildName into reusable function The new function is chisel3.internal.buildName. (cherry picked from commit 370ca8a) * Add --warn:reflective-naming This new argument (and associated annotation) will turn on a warning whenever reflective naming changes the name of a signal. This is provided to help migrate from Chisel 3.5 to 3.6 since reflective naming is removed in Chisel 3.6. (cherry picked from commit 97afd9b) 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
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.
This new argument (and associated annotation) will turn on a warning
whenever reflective naming changes the name of a signal. This is
provided to help migrate from Chisel 3.5 to 3.6 since reflective naming
is removed in Chisel 3.6.
I also factored
_computeNameout into a resuable function so that you can ask for the name of something given aseedandprefixwithout having to have aHasIdwith those fields set.This mega-conflicts with @mwachs5's #2556
Contributor Checklist
docs/src?Type of Improvement
API Impact
This adds a new CLI/annotation API to warn when some names will change between Chisel 3.5 and 3.6.
Backend Code Generation Impact
No impact
Desired Merge Strategy
Release Notes
Add
--warn:reflective-namingto enable a warning that indicates when the name of some value in the hardware will change in the migration from Chisel 3.5 to 3.6.Reviewer Checklist (only modified by reviewer)
3.4.x, [small] API extension:3.5.x, API modification or big change:3.6.0)?Enable auto-merge (squash), clean up the commit message, and label withPlease Merge.Create a merge commit.