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

[TASK] Enforce CVA6 Spyglass lint rules #1674

Open
1 task done
ASintzoff opened this issue Dec 5, 2023 · 1 comment
Open
1 task done

[TASK] Enforce CVA6 Spyglass lint rules #1674

ASintzoff opened this issue Dec 5, 2023 · 1 comment
Assignees
Labels
Component:RTL For issues in the RTL (e.g. for files in the rtl directory) Type:Task Project related task

Comments

@ASintzoff
Copy link
Contributor

ASintzoff commented Dec 5, 2023

Is there an existing CVA6 task for this?

  • I have searched the existing task issues

Task Description

Use verible to lint RTL located in cva6/core directory and enforce results with GitHub action running on each PR.

As verible is open-source, every CVA6 contributor can use it contrary to proprietary tools.

Required Changes

Remove lint warnings identified by verible rules

Current Status

Number of verible lint warnings on cva6/core directory on 2023-12-05 (commit 3720295)

verible-v0.0-3430-g060bde0f/bin/verible-verilog-lint *.sv */*.sv */*/*.sv

total: 1585
[always-ff-non-blocking]: 4
[case-missing-default]: 16
[enum-name-style]: 1
[explicit-function-lifetime]: 4
[explicit-parameter-storage-type]: 849
[forbid-line-continuations]: 1
[generate-label-prefix]: 22
[generate-label]: 50
[invalid-system-task-function]: 1
[line-length]: 318
[module-filename]: 3
[no-trailing-spaces]: 19
[package-filename]: 13
[parameter-name-style]: 177
[suggest-parentheses]: 1
[truncated-numeric-literal]: 9
[typedef-enums]: 14
[typedef-structs-unions]: 13
[undersized-binary-literal]: 13
[unpacked-dimensions-range-ordering]: 57

Risks

No response

Prerequisites

KPI (KEY Performance Indicators)

No response

Description of Done

  • Resolution of cva6/core directory lint warnings
  • For the unsolved warnings, related lint waivers in place
  • GitHub action enforcing verible lint on each pull request

Associated PRs

No response

@ASintzoff ASintzoff added the Component:RTL For issues in the RTL (e.g. for files in the rtl directory) label Dec 5, 2023
@ASintzoff ASintzoff added the Type:Task Project related task label Dec 5, 2023
@JeanRochCoulon
Copy link
Contributor

Spyglass has been preferred to Verible to execute LINT on CVA6.

@JeanRochCoulon JeanRochCoulon changed the title [TASK] Enforce CVA6 verible lint rules [TASK] Enforce CVA6 Spyglass lint rules May 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:RTL For issues in the RTL (e.g. for files in the rtl directory) Type:Task Project related task
Projects
Status: Todo
Development

No branches or pull requests

3 participants