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

write a 0.2.x -> 0.3.0 migration guide #530

Closed
japaric opened this issue Jul 15, 2021 · 2 comments · Fixed by #547
Closed

write a 0.2.x -> 0.3.0 migration guide #530

japaric opened this issue Jul 15, 2021 · 2 comments · Fixed by #547
Assignees
Labels
difficulty: medium Somewhat difficult to solve priority: high High priority for the Knurling team status: needs PR Issue just needs a Pull Request implementing the changes type: documentation Fixes, improvements or additions to the documentation
Milestone

Comments

@japaric
Copy link
Member

japaric commented Jul 15, 2021

0.3 will include several breaking changes. this guide would explain how to migrate code that uses defmt 0.2.x to 0.3.0

example of a migration guide: https://rtic.rs/0.5/book/en/migration.html

@japaric japaric added the type: documentation Fixes, improvements or additions to the documentation label Jul 15, 2021
@japaric japaric added this to the v0.3.0 milestone Jul 15, 2021
@Urhengulas Urhengulas added difficulty: medium Somewhat difficult to solve priority: high High priority for the Knurling team status: needs PR Issue just needs a Pull Request implementing the changes labels Jul 15, 2021
@Urhengulas Urhengulas self-assigned this Jul 15, 2021
@Urhengulas
Copy link
Member

Should this guide only list breaking changes, or also new features?

@japaric
Copy link
Member Author

japaric commented Jul 21, 2021

the focus should be on fixing things that no longer compile or no longer behave the same: changes in syntax; changes in API; defmt-* Cargo features no longer being needed; DEFMT_LOG now being a thing. It should offer a quick fix (e.g. to get the old behavior use DEFMT_LOG=info cargo r), ideally in the form of a diff when code is involved. To avoid repetition, the migration guide should defer / link to other dedicated sections of the book for details about new features (e.g. ISO timestamp display hint).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
difficulty: medium Somewhat difficult to solve priority: high High priority for the Knurling team status: needs PR Issue just needs a Pull Request implementing the changes type: documentation Fixes, improvements or additions to the documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants