aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/migration/migration_rtic.md
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2023-05-23 06:26:28 +0000
committerGitHub <noreply@github.com>2023-05-23 06:26:28 +0000
commit62162241d4c7d82dfbb310113f7525d134cfde9b (patch)
tree4346cbe248835eba381003d8592248102028dac5 /book/en/src/migration/migration_rtic.md
parent21b0d97e17922c023a3b5d8148a414d4277f7b87 (diff)
parent9fa073f7936782bddf5d02b7b1949032e84de1bd (diff)
Merge #741
741: Docs 2 r=korken89 a=datdenkikniet Working on the migration guide and other docs TODO: - [x] Migration guide - [x] Hardcoded examples should link to example code that is tested (this was already done, AFAICT) - [x] Address #699 - [x] Discuss: should we remove references to non-v2, apart from the migration guide and link to the book for v1? (Off-github conclusion: yes) - [x] RTIC {vs,and} Embassy (important: distinction between embassy runtime & HALs) - [x] More descriptive docs on how to implement & PR implementations of `Monotonic` to `rtic-monotonics` Co-authored-by: datdenkikniet <jcdra1@gmail.com>
Diffstat (limited to 'book/en/src/migration/migration_rtic.md')
-rw-r--r--book/en/src/migration/migration_rtic.md50
1 files changed, 0 insertions, 50 deletions
diff --git a/book/en/src/migration/migration_rtic.md b/book/en/src/migration/migration_rtic.md
deleted file mode 100644
index c027da3..0000000
--- a/book/en/src/migration/migration_rtic.md
+++ /dev/null
@@ -1,50 +0,0 @@
-# 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: () = {
- // ...
-
-};
-```