aboutsummaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorGravatar Jorge Aparicio <jorge@japaric.io> 2017-05-09 08:38:35 -0500
committerGravatar Jorge Aparicio <jorge@japaric.io> 2017-05-09 09:04:35 -0500
commit5cecc12d4cab326c73fb001898d46eac2a5f8566 (patch)
treec69de4499722c3232cef52b9b9a0358c1b859928 /src
parentacdfa6f09d27fea43926e1d286f13f27a811a203 (diff)
downloadrtic-5cecc12d4cab326c73fb001898d46eac2a5f8566.tar.gz
rtic-5cecc12d4cab326c73fb001898d46eac2a5f8566.tar.zst
rtic-5cecc12d4cab326c73fb001898d46eac2a5f8566.zip
v0.1.0v0.1.0
Diffstat (limited to 'src')
-rw-r--r--src/lib.rs8
1 files changed, 5 insertions, 3 deletions
diff --git a/src/lib.rs b/src/lib.rs
index 57f7f428..60cae6f9 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -18,10 +18,10 @@
//! multitasking**.
//! - **Efficient and data race free memory sharing** through fine grained *non
//! global* critical sections.
-//! - **Deadlock free execution**, guaranteed at compile time.
+//! - **Deadlock free execution** guaranteed at compile time.
//! - **Minimal scheduling overhead** as the scheduler has no "software
-//! component"; the hardware does all the scheduling.
-//! - **Highly efficient memory usage**. All the tasks share a single call stack
+//! component": the hardware does all the scheduling.
+//! - **Highly efficient memory usage**: All the tasks share a single call stack
//! and there's no hard dependency on a dynamic memory allocator.
//! - **All Cortex M3, M4 and M7 devices are fully supported**. M0(+) is
//! partially supported as the whole API is not available due to missing
@@ -489,6 +489,8 @@ impl<T, TASK> Local<T, TASK> {
unsafe impl<T, TASK> Sync for Local<T, TASK> {}
/// A resource with ceiling `C`
+///
+/// A resource is used to share memory between two or more tasks
pub struct Resource<T, C> {
_ceiling: PhantomData<C>,
data: UnsafeCell<T>,