Commit graph

121 commits

Author SHA1 Message Date
Emil Fresk
b71df58f2f The great docs update 2021-09-23 16:11:04 +02:00
Alex Martens
81a7722ab6 Fix link for SLEEPONEXIT 2021-08-26 14:29:18 -07:00
bors[bot]
8ddfcf8efc
Merge #504
504: Add links to RTIC book dev version and rtic-examples r=japaric a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@grepit.se>
2021-08-03 15:32:52 +00:00
CuriouslyCurious
f6f61f95a6 book: Properly update the note with a link 2021-07-30 12:44:35 +02:00
CuriouslyCurious
ae7b444f3d Revert "book: Add link to new.md"
This reverts commit 7a977f3fa9.
2021-07-30 12:43:35 +02:00
CuriouslyCurious
7a977f3fa9 book: Add link to new.md 2021-07-29 13:58:21 +02:00
CuriouslyCurious
e90e6332f6 book: Clarify target notice 2021-07-29 00:29:34 +02:00
CuriouslyCurious
007665eeee book: Add note to remember to choose target 2021-07-28 13:55:12 +02:00
Henrik Tjäder
5477ae288f Also link to rtic-examples in the tips section of the book 2021-07-27 20:04:56 +02:00
bors[bot]
adb4bc4c4e
Merge #502
502: book/resources: highlight that `#[lock_free]` includes a compile-time check r=AfoHT a=japaric

for the "same priority requirement"; this prevents data races

Co-authored-by: Jorge Aparicio <jorge.aparicio@ferrous-systems.com>
2021-07-22 10:51:16 +00:00
bors[bot]
b6e8e37c3c
Merge #500
500: migration/0.5: cover #[lock_free] r=AfoHT a=japaric

I think this completes #488

Co-authored-by: Jorge Aparicio <jorge.aparicio@ferrous-systems.com>
2021-07-22 10:45:46 +00:00
Jorge Aparicio
3eac8b91cf book/resources: highlight that #[lock_free] includes a compile-time check
for the "same priority requirement"; this prevents data races
2021-07-22 10:35:09 +02:00
Jorge Aparicio
a7ed040799 migration/0.5: cover #[lock_free]
I think this completes #488
2021-07-22 09:27:42 +02:00
Jorge Aparicio
5805a05fac book/resources: rm #[task_local] mention; add #[lock_free] example
the #[task_local] attribute was removed
2021-07-22 09:17:39 +02:00
Jorge Aparicio
cd4e8183f6 book/resources: remove mentions of the field attribute #[init(<expr>)]
it no longer exists. all resources are now late resources
2021-07-21 15:59:08 +02:00
Jorge Aparicio
6bf1c76d84 book/resources: do not use the lock API in the very first example
instead stick to `#[local]` resources
2021-07-21 15:55:14 +02:00
Jorge Aparicio
18880406cb use tuple struct syntax for Monotonics everywhere 2021-07-21 10:14:00 +02:00
Jorge Aparicio
5f7dc0b903 update the 0.5.x -> 0.6.0 migration guide
to use the new resources syntax
I also reordered the sections to cover all the resource API first before covering the spawn API
I've also added a section about the old `static mut` variable transform
2021-07-21 10:11:43 +02:00
Valentin Ochs
c4c964de7b Change misleading documentation left over by PR #464 2021-07-20 14:37:13 +02:00
Andrey Zgarbul
e4319de3d5 const generics 2021-07-09 18:44:19 +03:00
Alex Martens
1beeebd797 Fix syntax error in migration guide 2021-07-01 17:09:07 -07:00
bors[bot]
e6a22aa48e
Merge #479
479: book: detail import resolving for 0.6 migration r=korken89 a=tmplt

That is, answering the question of why imports are no longer resolving during compilation.

Co-authored-by: Viktor Sonesten <v@tmplt.dev>
2021-04-22 13:05:43 +00:00
Viktor Sonesten
1d5f129544 book/migration/v5: update init signature, fix example syntax
The example now migrates from v5 to v6 instead of an incorrect v6 syntax
to a another incorrect v6 syntax.
2021-04-21 15:38:00 +02:00
Viktor Sonesten
cfc97488db book: detail import resolving for 0.6 migration 2021-04-21 15:25:58 +02:00
Viktor Sonesten
374a1c2add book: update outdated required init signature 2021-04-21 15:00:53 +02:00
Barnaby Walters
f7767aabea
Minor grammar correction
you -> your
2021-02-05 23:09:06 +01:00
Emil Fresk
d36410a272 New logo, new text 2020-11-19 19:20:20 +01:00
Henrik Tjäder
d1517e436e Use SVG logo instead 2020-11-17 15:07:48 +00:00
Henrik Tjäder
3aeb91bad6 Add the logo to the book preface 2020-11-16 22:46:19 +01:00
Emil Fresk
d079949139 Add multilock to the book 2020-11-14 16:13:00 +01:00
Henrik Tjäder
b5ff671f89 Disable things which needs more work to be complete 2020-11-12 20:08:11 +00:00
bors[bot]
ebfabd7b30
Merge #411
411: Add section about task_local and lock_free r=perlindgren a=AfoHT



Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2020-11-12 18:34:05 +00:00
bors[bot]
65d0ee1f8e
Merge #408
408: Fixup app/new r=perlindgren a=AfoHT

Reference the current example

Co-authored-by: Henrik Tjäder <henrik@tjaders.com>
2020-11-12 18:29:58 +00:00
Henrik Tjäder
b0f6d60c3d Add static mut 2020-11-12 18:24:57 +00:00
bors[bot]
445730756e
Merge #410
410: resources r=AfoHT a=perlindgren

resources

Co-authored-by: Per Lindgren <per.lindgren@ltu.se>
2020-11-12 18:23:24 +00:00
Henrik Tjäder
29b81a23d6 Add section about task_local and lock_free 2020-11-12 18:15:42 +00:00
Per Lindgren
15bd129161 resources fix 2020-11-12 19:06:56 +01:00
Per Lindgren
0cb7cb0ba8 resources 2020-11-12 18:55:11 +01:00
bors[bot]
98f0a96104
Merge #409
409: Updated send/sync docs r=AfoHT a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2020-11-12 17:53:18 +00:00
Emil Fresk
0a578c76ca Updated send/sync docs 2020-11-12 18:46:24 +01:00
Henrik Tjäder
95a020c8af Fixup app/new 2020-11-12 17:45:12 +00:00
Emil Fresk
d25017a59c Fixed spawn and timer queue docs 2020-11-12 18:42:07 +01:00
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
Emil Fresk
5e3bbada63 Updated migration guide with symmetric locks and new spawn 2020-11-12 18:19:00 +01:00
Henrik Tjäder
1709d1c9c6 Fixup app/tips 2020-11-12 17:15:33 +00:00
Per Lindgren
96cd625223 extern task 2020-10-29 19:29:46 +01:00
Per Lindgren
1c244a995d move dispatchers to app argument 2020-10-23 23:58:09 +02: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