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

update CI to run clippy and docs #907

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

robamu
Copy link
Contributor

@robamu robamu commented Feb 7, 2025

No description provided.

@robamu robamu requested a review from a team as a code owner February 7, 2025 15:07
@robamu robamu force-pushed the ci-update-clippy-and-docs branch from 4e25011 to d82558b Compare February 7, 2025 15:09
@burrbull burrbull added the no changelog no-changelog label Feb 7, 2025
@burrbull
Copy link
Member

burrbull commented Feb 7, 2025

@burrbull
Copy link
Member

burrbull commented Feb 7, 2025

At least one doc job must be run on stable.

@burrbull
Copy link
Member

burrbull commented Feb 8, 2025

NRF ci fails with name collision. You should change one of suffixes https://docs.rs/svd2rust/latest/svd2rust/#the---ident-format-and---ident-formats-theme-flags

@burrbull
Copy link
Member

burrbull commented Feb 8, 2025

quotes

@burrbull
Copy link
Member

burrbull commented Feb 8, 2025

squash after error fixing, please.

@robamu
Copy link
Contributor Author

robamu commented Feb 8, 2025

Yes. One CPU fails in clippy due to some formatting issues with doc comments. That disappears when I run cargo fmt on the file. Not sure how to best continue here. I think most PACs use the form tool or at least run cargo fmt, so maybe it would be okay to run the formatter before running clippy and generating docs?

@robamu robamu force-pushed the ci-update-clippy-and-docs branch from f695e53 to 57d96d2 Compare February 8, 2025 11:45
@burrbull
Copy link
Member

SiliconLabs-SIM3L1x8_SVD fails.

By the way why CI does not show SVD-file URL?

@burrbull
Copy link
Member

Looks like issue with escaping newlines in some cases:

            #[doc = "If apb_pbyte_en\\[3:0\\]
= 1, a single byte is written/read to/from the TX/RX fifos.nElse, If apb_pbyte_en\\[3:0\\]
= 2, two bytes are written/read to/from the TX/RX fifos.nElse, If apb_pbyte_en\\[3:0\\]
= 3, three bytes are written/read to/from the TX/RX fifos.nElse, four bytes are written/read to/from the TX/RX fifos."]

@robamu
Copy link
Contributor Author

robamu commented Feb 13, 2025

SiliconLabs-SIM3L1x8_SVD fails.

By the way why CI does not show SVD-file URL?

See #914

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no changelog no-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants