diff options
| author | datdenkikniet <jcdra1@gmail.com> | 2023-04-22 21:27:26 +0200 |
|---|---|---|
| committer | datdenkikniet <jcdra1@gmail.com> | 2023-05-11 19:20:58 +0200 |
| commit | 3d97c9e431d7fcb20b1b30bc15c34ccffee03c79 (patch) | |
| tree | 6842b788361e247cc50423bee972cc7a3c6ba974 /book/en/deprecated/migration/migration_rtic.md | |
| parent | ed465b0c3b8b4c588f5cc7945af79a504f928cc8 (diff) | |
Move deprecated migration guides to deprecated folder
Diffstat (limited to 'book/en/deprecated/migration/migration_rtic.md')
| -rw-r--r-- | book/en/deprecated/migration/migration_rtic.md | 50 |
1 files changed, 50 insertions, 0 deletions
diff --git a/book/en/deprecated/migration/migration_rtic.md b/book/en/deprecated/migration/migration_rtic.md new file mode 100644 index 0000000..c027da3 --- /dev/null +++ b/book/en/deprecated/migration/migration_rtic.md @@ -0,0 +1,50 @@ +# Migrating from RTFM to RTIC + +This section covers how to upgrade an application written against RTFM v0.5.x to +the same version of RTIC. This applies since the renaming of the framework as per [RFC #33]. + +**Note:** There are no code differences between RTFM v0.5.3 and RTIC v0.5.3, it is purely a name +change. + +[RFC #33]: https://github.com/rtic-rs/rfcs/pull/33 + +## `Cargo.toml` + +First, the `cortex-m-rtfm` dependency needs to be updated to +`cortex-m-rtic`. + +``` toml +[dependencies] +# change this +cortex-m-rtfm = "0.5.3" + +# into this +cortex-m-rtic = "0.5.3" +``` + +## Code changes + +The only code change that needs to be made is that any reference to `rtfm` before now need to point +to `rtic` as follows: + +``` rust +// +// Change this +// + +#[rtfm::app(/* .. */, monotonic = rtfm::cyccnt::CYCCNT)] +const APP: () = { + // ... + +}; + +// +// Into this +// + +#[rtic::app(/* .. */, monotonic = rtic::cyccnt::CYCCNT)] +const APP: () = { + // ... + +}; +``` |
