Rule/explicit begin #2247
Merged
Rule/explicit begin #2247
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
Copied the code from suzizecat@0b087d7 and rebased it to the head. Updated the tests and formatted.
…d blocks for each supported statement.
Add rule to check if the begin keyword always follows a if/else/for. Related to chipsalliance#1321
Remove the fix suggestion as invalid
also move the error anchor to offending if/else/for in order to allow test to pass
Merge branch 'rule/explicit-begin' of https://github.com/sconwayaus/verible into rule/explicit-begin
Merge branch 'rule/explicit-begin' of https://github.com/sconwayaus/verible into rule/explicit-begin
…erible into rule/explicit-begin
…aces instead of begin-end. To keep things simple, this change ignores all statements inside a constraint.
sconwayaus
force-pushed
the
rule/explicit-begin
branch
11 times, most recently
from
aefa9e2
to
33d5ed0
Compare
sconwayaus
force-pushed
the
rule/explicit-begin
branch
from
33d5ed0
to
6da2fe5
Compare
|
Codecov ReportAttention: Patch coverage is
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## master #2247 +/- ##
==========================================
+ Coverage 92.91% 92.95% +0.04%
==========================================
Files 359 360 +1
Lines 26758 27039 +281
==========================================
+ Hits 24863 25135 +272
- Misses 1895 1904 +9 ☔ View full report in Codecov by Sentry. |
hzeller
reviewed
Sep 17, 2024
|
Adding @fangism as he always enjoys looking at new rules. |
hzeller
approved these changes
Sep 18, 2024
|
Looks like the automatic generation of the rule documentation picked this up https://chipsalliance.github.io/verible/lint.html#explicit-begin |
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 PR forks the initial work started in PR #1336 and extends the rule to check for begin-end blocks for all if, else, always, always_comb, always_latch, always_ff, for, forever, foreach, while and initial statements.
The rule is configurable allowing users to enable/disable this rule for each statement to provide some level of flexibility.
Aside from the usual unit testing, I've also spent the last 3 months using this rule in anger and it seems to be working quite well.
Resolves #2040
Related to #1321, misses on the case statement suggestion.