summaryrefslogtreecommitdiff
path: root/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib.rs')
-rw-r--r--src/lib.rs22
1 files changed, 20 insertions, 2 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 6188ed31..30a49021 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -30,7 +30,7 @@
//! # Constraints
//!
//! - Tasks must run to completion. That's it, tasks can't contain endless
-//! loops. However, you can run an endless event loop in the `idle` function.
+//! loops. However, you can run an endless event loop in the `idle` *loop*.
//!
//! - Task priorities must remain constant at runtime.
//!
@@ -44,7 +44,7 @@
//! [`svd2rust`]: https://docs.rs/svd2rust/0..0/svd2rust/
//! [`<cpu>`]: https://www.keil.com/pack/doc/CMSIS/SVD/html/elem_cpu.html
//!
-//! # More documentation
+//! # `app!`
//!
//! The `app!` macro is documented [here](../cortex_m_rtfm_macros/fn.app.html).
//!
@@ -52,6 +52,24 @@
//!
//! In increasing grade of complexity. See the [examples](./examples/index.html)
//! module.
+//!
+//! # References
+//!
+//! - Baker, T. P. (1991). Stack-based scheduling of realtime processes.
+//! *Real-Time Systems*, 3(1), 67-99.
+//!
+//! > The original Stack Resource Policy paper. [PDF][srp].
+//!
+//! [srp]: http://www.cs.fsu.edu/~baker/papers/mstacks3.pdf
+//!
+//! - Eriksson, J., Häggström, F., Aittamaa, S., Kruglyak, A., & Lindgren, P.
+//! (2013, June). Real-time for the masses, step 1: Programming API and static
+//! priority SRP kernel primitives. In Industrial Embedded Systems (SIES),
+//! 2013 8th IEEE International Symposium on (pp. 110-113). IEEE.
+//!
+//! > A description of the RTFM task and resource model. [PDF][rtfm]
+//!
+//! [rtfm]: http://www.diva-portal.org/smash/get/diva2:1005680/FULLTEXT01.pdf
#![deny(missing_docs)]
#![deny(warnings)]
#![feature(proc_macro)]