aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Viktor Sonesten <v@tmplt.dev> 2021-04-21 15:00:53 +0200
committerGravatar Viktor Sonesten <v@tmplt.dev> 2021-04-21 15:00:53 +0200
commit374a1c2add280ba0300474998e40f3712f40e9eb (patch)
tree536fecc35d67d1a7d161ce5c4aba5f418c8006e6
parent43c5ad79c27fbdefa00e2373eba554ec11e1d9df (diff)
downloadrtic-374a1c2add280ba0300474998e40f3712f40e9eb.tar.gz
rtic-374a1c2add280ba0300474998e40f3712f40e9eb.tar.zst
rtic-374a1c2add280ba0300474998e40f3712f40e9eb.zip
book: update outdated required init signature
-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