aboutsummaryrefslogtreecommitdiff
path: root/book/en/archive/migration/migration_rtic.md
diff options
context:
space:
mode:
authordatdenkikniet <jcdra1@gmail.com>2023-05-05 18:58:06 +0200
committerdatdenkikniet <jcdra1@gmail.com>2023-05-11 19:20:58 +0200
commite3603d1d0531a4593c4c75863fc77162813cf34f (patch)
treef2b5562851c68c6e4ba9b6a79f96d9b292a4d8e7 /book/en/archive/migration/migration_rtic.md
parent0b8ea078e5df356e6ad86c5c7f9facbc0822ed8b (diff)
Rename deprecated to archive
Diffstat (limited to 'book/en/archive/migration/migration_rtic.md')
-rw-r--r--book/en/archive/migration/migration_rtic.md50
1 files changed, 50 insertions, 0 deletions
diff --git a/book/en/archive/migration/migration_rtic.md b/book/en/archive/migration/migration_rtic.md
new file mode 100644
index 0000000..e079cbf
--- /dev/null
+++ b/book/en/archive/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,noplayground
+//
+// Change this
+//
+
+#[rtfm::app(/* .. */, monotonic = rtfm::cyccnt::CYCCNT)]
+const APP: () = {
+ // ...
+
+};
+
+//
+// Into this
+//
+
+#[rtic::app(/* .. */, monotonic = rtic::cyccnt::CYCCNT)]
+const APP: () = {
+ // ...
+
+};
+```