Skip to content

update dependencies (primary goal: defmt v1.0) & use defmt again in lib #61

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

Merged

Conversation

rursprung
Copy link
Collaborator

@rursprung rursprung commented Apr 8, 2025

please see the individual commit messages!

doing this manually rather than letting dependabot take care of it to document that this is a non-breaking change.
due to the semver trick there's also no need to release a new version of the crate immediately.

also please note that that the defmt dependency was unused; i've re-introduced the usage since it was already present and thus offered a feature for consumers to enable (removing which would've been a breaking change)

`defmt` released v1.0 and used the semver trick (releasing v0.3.100) to
make updating to it non-breaking.
this was intentionally done in a separate commit to make it clear that
the library update is non-breaking.
@rursprung rursprung added the dependencies Pull requests that update a dependency file label Apr 8, 2025
@rursprung rursprung requested review from eldruin, jannic and ripytide April 8, 2025 07:39
@rursprung rursprung changed the title update dependencies (primary goal: defmt v1.0) update dependencies (primary goal: defmt v1.0) & use defmt again in lib Apr 8, 2025
i had forgotten to completely remove the dependency in the now reverted
commit, thus the optional dependency still created a feature which
consuming crates could enable. removing it would be a breaking change.
this leaves two options:
* remove the `defmt` _dependency_ and add a dummy _feature_ of the same
  name, issuing a compile warning if it is enabled, eventually removing
  it in v2.0 if or when that will ever be released
* accept the fact that we already have the optional dependency and thus
  the feature and make use of it

this contains a few changes to the reverted commit:
* the feature is now called `defmt` rather than `defmt-03` (as that's
  the name of the implicit feature for the optional dependency)
* the `debug` output in `drive` is kept but downgraded to `trace` and
  slightly reworded (the speed is already present in the command)
* the `cfg`-guarded `use` is removed to make the code cleaner

This reverts commit d9da807.
(with minor adaptations)
@rursprung rursprung force-pushed the dependency-updates branch from e8072bf to 0d014af Compare April 9, 2025 06:02
@rursprung rursprung requested a review from jannic April 9, 2025 06:03
@rursprung rursprung merged commit 66b214f into rust-embedded-community:master Apr 9, 2025
8 checks passed
@rursprung rursprung deleted the dependency-updates branch April 9, 2025 07:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants