mirror of
https://github.com/rtic-rs/rtic.git
synced 2024-12-24 02:49:34 +01:00
Updated book with migration guide for RTFM -> RTIC
This commit is contained in:
parent
7030d23d63
commit
5f860dcdf5
2 changed files with 55 additions and 0 deletions
|
@ -10,6 +10,7 @@
|
|||
- [Starting a new project](./by-example/new.md)
|
||||
- [Tips & tricks](./by-example/tips.md)
|
||||
- [Migrating from v0.4.x to v0.5.0](./migration.md)
|
||||
- [Migrating from RTFM to RTIC](./migration_rtic.md)
|
||||
- [Under the hood](./internals.md)
|
||||
- [Interrupt configuration](./internals/interrupt-configuration.md)
|
||||
- [Non-reentrancy](./internals/non-reentrancy.md)
|
||||
|
|
54
book/en/src/migration_rtic.md
Normal file
54
book/en/src/migration_rtic.md
Normal file
|
@ -0,0 +1,54 @@
|
|||
# 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: () = {
|
||||
// ...
|
||||
|
||||
};
|
||||
```
|
||||
|
Loading…
Reference in a new issue