Repository navigation
Conversation
trmckay
commented
Oct 13, 2026
Comment on lines
+68
to
+71
| // These internal inline-test APIs are renamed | ||
| ProblemFilter.exclude[MissingClassProblem]("chisel3.internal.InlineTestIncluder"), | ||
| ProblemFilter.exclude[MissingClassProblem]("chisel3.internal.InlineTestIncluder$"), | ||
| ProblemFilter.exclude[DirectMissingMethodProblem]("chisel3.stage.ChiselOptions.inlineTestIncluder"), |
Contributor
Author
There was a problem hiding this comment.
These seemed fair to remove given they are internal or highly unlikely to be used externally.
Contributor
|
Discussed offline but we should do the "Texas two-step"1:
Add a TODO for (2) to #5100. Footnotes
|
trmckay
force-pushed
the
rename-auto-test
branch
from
October 16, 2026 23:26
83ef4e3 to
4475821
Compare
Contributor
Author
|
I want to hold off for a bit on merging this on this so I can minimize API changes across other related PRs. |
This branch has not been deployed
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
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.
Summary
Renames the inline test API to "auto-test", which more accurately describes its purpose: a feature which lets you automatically discover and run tests that come out of a generator. The "inline" naming comes from the fact that these are declared inline with the DUT generator. But, that's not really the most important part of this API, IMO and more of an implementation detail. Furthermore, there are other use-cases where you might want to elaborate an inline test(harness) that are not this "auto-test" use-case.
I'm also considering whether we should move this out of
experimental. I originally put it there to avoid PRs like this. But, now that I understand that we still try to maintain binary compatibility even here, I don't see the point of keeping here.I have more PRs incoming for API improvements and consolidation with
chisel3.UnitTestandcirct-test. So, I want to get this out of the way first.This turned out a lot messier than I had hoped it would. So much so, it has me questioning whether it's worth it. But,a at the same time, I don't know if source code style is a good reason to not give this API a more appropriate name. So, consider this PR a RFC.
Release Notes
chisel3.experimental.inlinetestand rename tochisel3.experimental.autotest.Development notes