chore: multiple minor cleanups #872
Conversation
### consolidate workspace settings * Ensure all crates are consistently configured and validated using workspace features * move edition, license, repo, and rust-version (where used) to workspace * remove readme setting (already set by default) * add lints section - this should be used in a separate PR ### Code changes * Migrate several examples to 2021 edition ### Other changes * `crates.json` reformatted for consistency and ease-of-reading * Reformat all Cargo.toml that have already been modified with consistent spacing using intellij built-in formatter (pretty similar to what was already used, and it is being proposed for the toml formatting in rustfmt, but that has stalled)
There was a problem hiding this comment.
Thanks for the contributions @nyurik and apologies for my taking a few days to follow up. I'd hoped that by combining the three earlier PRs that we'd get a clearer view of changes you're requesting, and by keeping the commits separate we'd be able to easily pick and choose between them.
I appreciate the docstring cleanups, but to be frank I think most of the rest of this is a bit questionable value (eg whitespace changes) or problematic (eg tying tier 2 BSP config to the workspace). Probably best to discuss details in chat.
| repository = "https://github.com/atsamd-rs/atsamd" | ||
| rust-version = "1.77.2" | ||
|
|
||
| [workspace.lints.rust] |
There was a problem hiding this comment.
What is the reason for adding these empty lints sections?
| repository = "https://github.com/atsamd-rs/atsamd" | ||
| readme = "README.md" | ||
| edition = "2021" | ||
| edition.workspace = true |
There was a problem hiding this comment.
Since this is a "tier 2" BSP, I don't think we want to use the wider workspace settings for it, that kinda defeats the purpose of the distinction from tier 1.
| version = "0.19.0" | ||
| edition.workspace = true | ||
| license.workspace = true | ||
| repository.workspace = true |
There was a problem hiding this comment.
I wonder if the repository link for BSPs shouldn't actually go to eg https://github.com/atsamd-rs/atsamd/tree/master/boards/metro_m0
| "defmt", | ||
| "async" | ||
| ], | ||
| "features": [ "samd11c", "dma", "defmt", "async" ], |
There was a problem hiding this comment.
Is there a reason to change the formatting in this file?
Per @ianrrees review (thx!), this consolidates #860 #861#862
consolidate workspace settings
Code changes
Other changes
crates.jsonreformatted for consistency and ease-of-reading