aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/migration/migration_v2.md
diff options
context:
space:
mode:
authordatdenkikniet <jcdra1@gmail.com>2023-04-22 18:25:00 +0200
committerdatdenkikniet <jcdra1@gmail.com>2023-05-11 19:20:58 +0200
commitd90fa95266bc9864d2dec0248fa4bae5c7e5b6ec (patch)
treefae20e927b0d9d5f1b13921d65699d3dde72e053 /book/en/src/migration/migration_v2.md
parent1dc2f80eb6cb6ac6d1eaede4169d8cabc51c5e7c (diff)
Add some more
Diffstat (limited to 'book/en/src/migration/migration_v2.md')
-rw-r--r--book/en/src/migration/migration_v2.md6
1 files changed, 4 insertions, 2 deletions
diff --git a/book/en/src/migration/migration_v2.md b/book/en/src/migration/migration_v2.md
index 071d34c..96fa231 100644
--- a/book/en/src/migration/migration_v2.md
+++ b/book/en/src/migration/migration_v2.md
@@ -5,11 +5,13 @@ Migrating a project from RTIC `v1.0.x` to `v2.0.0` involves the following steps:
1. `v2.0.0` requires [`#![type_alias_impl_trait]`](https://github.com/rust-lang/rust/issues/63063) and Rust Nightly.
2. Migrating from the monotonics included in `v1.0.x` to `rtic-time` and `rtic-monotonics`, replacing `spawn_after`, `spawn_at`.
3. Software tasks are now required to be `async`, and using them correctly.
-4. Understanding and using data types provided by `rtic-sync` to solve migration problems.
+4. Understanding and using data types provided by `rtic-sync`.
+
+For a detailed description of the changes, refer to the subchapters.
If you wish to see a code example of changes required, you can check out [the full example migration page](./migration_v2/complete_example.md).
-## TL;DR
+#### TL;DR (Too Long; Didn't Read)
1. Add `#![type_alias_impl_trait]` to your crate, and use `cargo +nightly`.
2. Instead of `spawn_after` and `spawn_at`, you now use the `async` functions `delay`, `delay_until` (and related) with impls provided by `rtic-monotonics`.
3. Software tasks _must_ be `async fn`s now. Not returning from a task is allowed so long as there is an `await` in the task. You can still `lock` shared resources.