From d81c3758d5633c22342cb60069243243f9d38df5 Mon Sep 17 00:00:00 2001 From: Robin Mueller <31589589+robamu@users.noreply.github.com> Date: Wed, 18 Sep 2024 15:14:28 +0200 Subject: [PATCH] update docs (#977) Add notice for systems without native CAS operations --- rtic-monotonics/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/rtic-monotonics/src/lib.rs b/rtic-monotonics/src/lib.rs index 70a89fc90d..9245f4539b 100644 --- a/rtic-monotonics/src/lib.rs +++ b/rtic-monotonics/src/lib.rs @@ -1,6 +1,11 @@ //! In-tree implementations of the [`rtic_time::Monotonic`] (reexported) trait for //! timers & clocks found on commonly used microcontrollers. //! +//! If you are using a microcontroller where CAS operations are not available natively, you might +//! have to enable the `critical-section` or `unsafe-assume-single-core` feature of the +//! [`portable-atomic`](https://docs.rs/portable-atomic/latest/portable_atomic/) dependency +//! yourself for this dependency to compile. +//! //! To enable the implementations, you must enable a feature for the specific MCU you're targeting. //! //! # Cortex-M Systick