aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar bors[bot] <26634292+bors[bot]@users.noreply.github.com> 2021-04-21 13:18:25 +0000
committerGravatar GitHub <noreply@github.com> 2021-04-21 13:18:25 +0000
commit426662b1982e5ab1e3ddad8ef6fa702a74cd0280 (patch)
treebae17951a68e186758cf306876a04fe0b0274550
parent99a53c7ca7648a38899f8f042d2b4f4dbbeccdd6 (diff)
parent374a1c2add280ba0300474998e40f3712f40e9eb (diff)
downloadrtic-426662b1982e5ab1e3ddad8ef6fa702a74cd0280.tar.gz
rtic-426662b1982e5ab1e3ddad8ef6fa702a74cd0280.tar.zst
rtic-426662b1982e5ab1e3ddad8ef6fa702a74cd0280.zip
Merge #478
478: book: update outdated required init signature r=korken89 a=tmplt As per the title. The required signature of `#[init]` in the flowing text has not yet been updated for v0.6.0. Co-authored-by: Viktor Sonesten <v@tmplt.dev>
-rw-r--r--book/en/src/by-example/app.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/book/en/src/by-example/app.md b/book/en/src/by-example/app.md
index 6a011936..50f2842c 100644
--- a/book/en/src/by-example/app.md
+++ b/book/en/src/by-example/app.md
@@ -23,9 +23,8 @@ to use the [`cortex_m_rt::entry`] attribute.
## `init`
Within the `app` module the attribute expects to find an initialization
-function marked with the `init` attribute. This function must have signature
-`fn(init::Context) [-> init::LateResources]` (the return type is not always
-required).
+function marked with the `init` attribute. This function must have
+signature `fn(init::Context) -> (init::LateResources, init::Monotonics)`.
This initialization function will be the first part of the application to run.
The `init` function will run *with interrupts disabled* and has exclusive access