Commit graph

108 commits

Author SHA1 Message Date
Daniel Carosone
baa2edfe72 close console text blocks on a new line
fixes #369
2020-10-02 19:38:00 +10:00
Henrik Tjäder
1e46ffdfbc
Merge branch 'master' into mod_const 2020-10-02 11:36:28 +02: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
0cc556a75a Remove all of heterogeneous and homogeneous from the book 2020-10-01 19:12:54 +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
Emil Fresk
cfd5f4785e
Merge pull request #329 from rtic-rs/v0.5.3_release
Preparing for v0.5.3
2020-06-12 10:03:26 +02:00
Emil Fresk
5f860dcdf5 Updated book with migration guide for RTFM -> RTIC 2020-06-12 09:50:12 +02:00
Nicolas Stalder
ae5f2bc796 Link to GitHub from book 2020-06-11 21:27:57 +02:00
Henrik Tjäder
ff4370944f Small renaming fixes 2020-06-11 18:29:25 +00: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
Scott Mabin
864ec2ebc9 Update migration guide to include the enabling of the the DWT peripheral. Also makes note of enable trace with the DCB to allow the DWT to work without a debugger connected. 2019-12-03 11:33:24 +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
Emil Fresk
1ba2b5abbe Fixed peripherals -> device typo 2019-10-23 20:31:33 +02:00
Jorge Aparicio
1fe9767eba version v0.5 is still beta 2019-10-17 12:00:45 -05:00
bors[bot]
e82fb497f0
Merge #256
256: add migration guide r=korken89 a=japaric



Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2019-10-17 06:16:43 +00:00
Jorge Aparicio
4b61c345eb ARMv7-M+ 2019-10-16 16:36:06 -05:00
Jorge Aparicio
66a1993f5d add migration guide 2019-10-16 14:39:02 -05:00
bors[bot]
47e4d99907
Merge #255
255: more monotonic timer docs r=nils-grepit a=japaric

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
cc @jonas-schievink

(EDIT: yay, pull request number 0xFF)

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2019-10-16 19:07:28 +00: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
bors[bot]
8a1f009c34
Merge #252
252: critical sections book: each task gets its own context r=japaric a=chrysn

Fixing what was probably a copy-paste error; different tasks each have different types for their context.

Co-authored-by: chrysn <chrysn@fsfe.org>
2019-10-15 22:43:59 +00:00
Jorge Aparicio
eb2ec7a4c8 v0.5.0 beta release 2019-10-15 16:35:00 -05:00
chrysn
bbd47e20ee
critical sections: each task gets its own context
Fixing what was probably a copy-paste error; different tasks each have different types for their context argument.
2019-10-10 16:42:26 +02:00
Jorge Aparicio
d08f965080 fix linkchecker warning 2019-09-17 20:40:34 +02:00
Jorge Aparicio
1e0cfa19ba fix more links 2019-09-17 19:55:55 +02:00
Jorge Aparicio
fa3872a7f6 update the CHANGELOG
also fix link to the older documentation
2019-09-17 19:47:29 +02:00
bors[bot]
f1a9d0bb29
Merge #241
241: One more place links updated r=japaric a=korken89



Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
2019-09-15 20:50:03 +00:00
Emil Fresk
c818a31058 Book fix 2019-09-15 22:08:28 +02:00
Jorge Aparicio
b410f309b7 link to older docs from the book 2019-09-15 21:00:49 +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
009ca9a0be fix link 2019-08-21 10:28:07 +02:00
Jorge Aparicio
07b2b4d830 doc up 2019-08-21 10:17:27 +02:00
bors[bot]
6acb156482 Merge #189
189: write generated code to disk for easier inspection r=japaric a=japaric

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`

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
2019-05-09 19:53:56 +00:00
Jorge Aparicio
ea02405ef0 document resolution and range of Instant and Duration 2019-05-08 19:48:12 +02:00
Jorge Aparicio
d1d2aff34b fix typo 2019-05-08 14:12:07 +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
09ec5a7a41 document internals
note that this assumes that RFC #155 has been implemented
2019-05-01 22:36:54 +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
Eric Trombly
19212a9f70 update commit for example link and specify RTFM version 2019-04-21 09:21:33 -05:00
Eric Trombly
21db4d1df4 add sandbox example 2019-04-19 10:50:43 -05: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