Commit graph

42 commits

Author SHA1 Message Date
bors[bot]
5b8b2383e1
Merge #405 #406
405: Updated migration guide with symmetric locks and new spawn r=AfoHT a=korken89



406: book.toml/by-example/app r=korken89 a=perlindgren

Book update

Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2020-11-12 17:24:44 +00:00
Per Lindgren
91ea1e428b book.toml/by-example/app 2020-11-12 18:20:16 +01:00
Henrik Tjäder
1709d1c9c6 Fixup app/tips 2020-11-12 17:15:33 +00:00
Dion Dokter
7a57f16860
Made relation between priority and number explicit
When quickly reading through the priorities chapter, I couldn't find in which order the priorities were, so I assumed it was the same as in the hardware.
In the cortex-m hardware, interrupts with the **lower** priority number will preempt the other interrupts.
RTIC does the reverse, so I think it's good to be more explicit about it.
2020-10-15 17:45:34 +02:00
Daniel Carosone
efe6b516fb device path must be absolute; clarify 2020-10-13 10:45:03 +11:00
Daniel Carosone
f386cb63cb Merge branch 'master'
of https://github.com/rtic-rs/cortex-m-rtic
2020-10-07 09:22:38 +11:00
bors[bot]
dbf9a7f298
Merge #368
368: Mod over const r=korken89 a=AfoHT

Related [RFC](https://github.com/rtic-rs/rfcs/pull/34)

Dependent on [rtic-syntax-PR30](https://github.com/rtic-rs/rtic-syntax/pull/30)

~~Currently using my own dev-branch~~

Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2020-10-05 08:40:19 +00:00
Emil Fresk
f0f982faca Updated documentation to include the critical section token in init 2020-10-03 15:30:15 +02:00
Daniel Carosone
3d6a0ea64f minor markdownlints 2020-10-02 20:43:52 +10:00
Daniel Carosone
91c2d4850e Shared access is useful with interior mutability 2020-10-02 19:56:17 +10:00
Henrik Tjäder
e6bc673621 Clarify the need for resources-attribute 2020-10-02 09:42:50 +00:00
Daniel Carosone
baa2edfe72 close console text blocks on a new line
fixes #369
2020-10-02 19:38:00 +10:00
Henrik Tjäder
9ca10b0d8c Add migration to 0.6 along with updated documentation 2020-10-02 09:33:28 +00:00
Henrik Tjäder
163edd7579 Start updating the book 2020-10-01 16:59:27 +00:00
Emil Fresk
e487b235eb Improved loop example docs to highlight that one cannot have empty loops in idle 2020-09-15 15:41:14 +02:00
bors[bot]
027b11f6b4
Merge #343
343: Updated URL for example 'init.rs' file r=AfoHT a=regexident

(the file at tag '0.5.0' still uses `rtfm`, rather than `rtic` from tag '0.5.3' or later)

Co-authored-by: Vincent Esche <regexident@gmail.com>
2020-07-15 06:55:05 +00:00
Vincent Esche
0616435ba6 Updated URL for example 'init.rs' file
(the file at tag '0.5.0' still uses `rtfm`, rather than `rtic` from tag '0.5.3' or later)
2020-07-14 16:26:03 +02:00
Vincent Esche
e9fa71c065 Fixed some more spelling 2020-07-14 16:01:14 +02:00
Vincent Esche
3b48447934 Unified spelling of "real-time" (vs. "real time")
(This spelling is consistent with the one provided by Merriam Webster for use an an adjective)
2020-07-14 16:00:42 +02:00
Henrik Tjäder
602a5b4374 Rename RTFM to RTIC 2020-06-11 17:18:29 +00:00
KENTARO OKUDA
d44f5582d9 Update resources.md 2020-06-11 09:45:53 -04:00
KENTARO OKUDA
6e59dacdc3 Update app.md 2020-05-13 07:35:51 -04:00
Peter Taylor
02f965ef09
correct SLEEPONEXIT reference link 2020-04-13 09:32:49 -06:00
Henrik Tjäder
1a1a1e2167 Reference the correct example 2020-01-24 15:34:41 +00:00
Jorge Aparicio
73d5fa31c2 remove references to 'beta' from the docs 2019-11-14 18:19:57 -05:00
Emil Fresk
76e234599f Added struct de-structure-ing example in tips & tricks 2019-11-07 14:12:16 +01:00
Jorge Aparicio
1ccacf2102
Update book/en/src/by-example/timer-queue.md
Co-Authored-By: Jonas Schievink <jonasschievink@gmail.com>
2019-10-16 17:04:42 +00:00
Jorge Aparicio
eef4e7bf79 more monotonic timer docs
covers

- initialization and configuration of the timer; this is now a responsibility of
  the application author
- correctness of `Monotonic::now()` in `#[init]`
- safety of `Monotonic::reset()`

closes #251
2019-10-15 18:44:49 -05:00
Jorge Aparicio
eb2ec7a4c8 v0.5.0 beta release 2019-10-15 16:35:00 -05:00
Jorge Aparicio
1e0cfa19ba fix more links 2019-09-17 19:55:55 +02:00
Jorge Aparicio
996bdf8f0c doc tweaks 2019-08-21 12:33:04 +02:00
Jorge Aparicio
7ca5bbf404 fix preempt example 2019-08-21 10:53:13 +02:00
Jorge Aparicio
07b2b4d830 doc up 2019-08-21 10:17:27 +02:00
Jorge Aparicio
d4eb4d2c47 write generated code to disk for easier inspection
now that the generated code is actually readable let's make it easier to access

this commit also documents how to inspect the generated code via
`rtfm-expansion.rs` and `cargo-expand`
2019-05-08 14:08:09 +02:00
Jorge Aparicio
ccd7f4586b book: indirection for faster message passing 2019-05-01 21:32:00 +02:00
Jorge Aparicio
3adc9c31f3 update the book 2019-05-01 20:49:25 +02:00
Jorge Aparicio
e865cbb2e5 book: resources shared with init must also be Send 2019-04-21 18:00:22 +02:00
Jorge Aparicio
c4bad51deb note that late resources must be Send 2019-04-21 18:00:22 +02:00
Jorge Aparicio
aa7eec0299 check task priority at compile time
before we were checking the priority at runtime. The compile time error message
when the priority is too high is kind of awful though.
2019-04-16 23:04:24 +02:00
Jorge Aparicio
e167af01f0 document the binds feature
cc @burrbull
2019-02-26 23:22:34 +01:00
Jorge Aparicio
1e9058cab2 (en) update the text related to late resources
cc @burrbull
2019-02-12 15:13:41 +01:00
Jorge Aparicio
0007a35a27 change layout of books 2019-02-11 21:40:53 +01:00