improve defmt version mismatch diagnostics #242
Conversation
offer a different suggestion based on whether a git or crates.io version is being used
| defmt = {{ git = \"https://github.com/knurling-rs/defmt\", rev = \"{0}\" }} | ||
| defmt-rtt = {{ git = \"https://github.com/knurling-rs/defmt\", rev = \"{0}\" }} | ||
| # ONLY pin this dependency if you are using the `print-defmt` feature | ||
| panic-probe = {{ git = \"https://github.com/knurling-rs/defmt\", features = [\"print-defmt\"], rev = \"{0}\" }}", |
There was a problem hiding this comment.
panic-probe currently lives in the probe-run repo so it's not really possible to pin it to the correct defmt rev (panic-probe also already pins to a particular defmt and that cannot be changed from an application project). I think that to simplify the use of the git-version of defmt we'll have to move panic-probe (back) into the defmt repo. This PR is blocked on that migration.
| Git, | ||
| } | ||
|
|
||
| impl Kind { |
There was a problem hiding this comment.
question: why are these defined within the function instead of outside?
There was a problem hiding this comment.
the enum is only used within the function body so putting it inside avoids adding yet another type to the outer (src/lib.rs) type namespace.
Another way to keep the namespace tidy is use modules so this could have been written as: mod version { enum Kind { .. } pub fn check(version: &str) -> Result<(), String> { .. } }. We have not used modules in this crate at all so the file is over 1.6K lines ... we should eventually come back and refactor this into modules.
There was a problem hiding this comment.
alrighty, thank you for the clarification! +1 to the refactoring, but that's for another day ofc
|
reminder to self: publish a new patch version of |
offer a different suggestion based on whether a git or crates.io version is being used
should be merged after #244