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

Add build target for cargo clippy in Veracruz Makefile #37

Closed
dominic-mulligan-arm opened this issue Nov 6, 2020 · 3 comments
Closed
Labels
build-process Something related to the Veracruz build process enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@dominic-mulligan-arm
Copy link
Member

At the moment we do not have support for the Clippy linter in the Veracruz Makefile. Some of Clippy's lint groups would be useful to check on the Veracruz codebase, especially those related to correctness, performance, and idiomatic Rust code style. In the past, I quickly experimented with Clippy on Veracruz but found that lint warnings in our code were swamped by warnings originating from our dependencies. Apparently, this cannot be turned off (see e.g. here). However, maybe this situation has changed, or maybe there's some way of filtering the lint warnings to produce warnings originating from only our code, or similar, which should be investigated.

@dominic-mulligan-arm dominic-mulligan-arm added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed build-process Something related to the Veracruz build process labels Nov 6, 2020
@Mo-Fatah
Copy link
Contributor

Mo-Fatah commented Apr 20, 2022

should this solve it now ?

@Mo-Fatah
Copy link
Contributor

Mo-Fatah commented Apr 23, 2022

After being able to exclude dependencies from clippy warnings, I have a proposal for clippy in Veracruz

  1. Add clippy target to each Makefile in all workspaces. Each clippy target will scan only the members and relevant dependencies of the specified workspace. For example, running make clippy inside veracruz/workspaces/linux-host will generate only warnings for our dependencies and the members of the linux-host workspace excluding all external dependencies.

  2. Add clippy target to workspaces/Makefile, which will invoke all clippy targets in all workspaces.

  3. After making sure that our clippy targets are behaving as expected, I think Veracruz team should discuss our clippy configurations if there are any unnecessary rules

  4. Add clippy to our CI workflow. We can either

    • add it as an independent job that will invoke clippy targets in all workspaces
    • or add it as an included step in each job , and each job will invoke its clippy target from the corresponding Makefile

I made a PR here #419

This was referenced Apr 23, 2022
@dreemkiller
Copy link
Member

We have this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-process Something related to the Veracruz build process enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants