diff options
| -rw-r--r-- | book/en/src/migration/migration_v4.md | 15 | ||||
| -rw-r--r-- | book/en/src/migration/migration_v5.md | 8 |
2 files changed, 12 insertions, 11 deletions
diff --git a/book/en/src/migration/migration_v4.md b/book/en/src/migration/migration_v4.md index 2c4e3ade..ac59d8c9 100644 --- a/book/en/src/migration/migration_v4.md +++ b/book/en/src/migration/migration_v4.md @@ -3,7 +3,7 @@ This section covers how to upgrade an application written against RTIC v0.4.x to the version v0.5.0 of the framework. -### `Cargo.toml` +## `Cargo.toml` First, the version of the `cortex-m-rtic` dependency needs to be updated to `"0.5.0"`. The `timer-queue` feature needs to be removed. @@ -21,7 +21,7 @@ features = ["timer-queue"] # ^^^^^^^^^^^^^ ``` -### `Context` argument +## `Context` argument All functions inside the `#[rtic::app]` item need to take as first argument a `Context` structure. This `Context` type will contain the variables that were @@ -73,7 +73,7 @@ const APP: () = { }; ``` -### Resources +## Resources The syntax used to declare resources has been changed from `static mut` variables to a `struct Resources`. @@ -97,7 +97,7 @@ const APP: () = { }; ``` -### Device peripherals +## Device peripherals If your application was accessing the device peripherals in `#[init]` through the `device` variable then you'll need to add `peripherals = true` to the @@ -135,7 +135,7 @@ const APP: () = { }; ``` -### `#[interrupt]` and `#[exception]` +## `#[interrupt]` and `#[exception]` The `#[interrupt]` and `#[exception]` attributes have been removed. To declare hardware tasks in v0.5.x use the `#[task]` attribute with the `binds` argument. @@ -181,9 +181,10 @@ const APP: () = { }; ``` -### `schedule` +## `schedule` -The `timer-queue` feature has been removed. To use the `schedule` API one must +The `schedule` API no longer requires the `timer-queue` cargo feature, which has +been removed. To use the `schedule` API one must first define the monotonic timer the runtime will use using the `monotonic` argument of the `#[rtic::app]` attribute. To continue using the cycle counter (CYCCNT) as the monotonic timer, and match the behavior of version v0.4.x, add diff --git a/book/en/src/migration/migration_v5.md b/book/en/src/migration/migration_v5.md index 749ddecd..1d83444e 100644 --- a/book/en/src/migration/migration_v5.md +++ b/book/en/src/migration/migration_v5.md @@ -2,11 +2,11 @@ This section describes how to upgrade from v0.5.x to v0.6.0 of the RTIC framework. -### `Cargo.toml` - version bump +## `Cargo.toml` - version bump Change the version of `cortex-m-rtic` to `"0.6.0"`. -### Module instead of Const +## Module instead of Const With the support of attributes on modules the `const APP` workaround is not needed. @@ -32,7 +32,7 @@ Now that a regular Rust module is used it means it is possible to have custom user code within that module. Additionally, it means that `use`-statements for resources etc may be required. -### Init always returns late resources +## Init always returns late resources In order to make the API more symmetric the #[init]-task always returns a late resource. @@ -64,7 +64,7 @@ mod app { } ``` -### Resources struct - #[resources] +## Resources struct - #[resources] Previously the RTIC resources had to be in in a struct named exactly "Resources": |