diff options
| author |  Dario Nieuwenhuis <dirbaio@dirbaio.net>
| 2022-08-22 00:16:46 +0200 |
|---|---|---|
| committer | Dario Nieuwenhuis <dirbaio@dirbaio.net>
| 2022-08-22 20:23:39 +0200 |
| commit | e0eeec4c5ea50a4d85df8754cd29673930a8065d (patch) | |
| tree | 1ecb59eedd09f4561f97803e139246ba16f5b833 | |
| parent | 0e530549de322684c50e858c6bb985afb5479dbe (diff) | |
| download | cortex-m-e0eeec4c5ea50a4d85df8754cd29673930a8065d.tar.gz cortex-m-e0eeec4c5ea50a4d85df8754cd29673930a8065d.tar.zst cortex-m-e0eeec4c5ea50a4d85df8754cd29673930a8065d.zip | |
Fix outdated comment in `singleton!`.
| -rw-r--r-- | src/macros.rs | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/macros.rs b/src/macros.rs index 21bf78b..4f43133 100644 --- a/src/macros.rs +++ b/src/macros.rs @@ -31,7 +31,10 @@ macro_rules! iprintln { /// at most once in the whole lifetime of the program. /// /// # Notes -/// This macro is unsound on multi core systems. +/// +/// This macro requires a `critical-section` implementation to be set. For most single core systems, +/// you can enable the `critical-section-single-core` feature for this crate. For other systems, you +/// have to provide one from elsewhere, typically your chip's HAL crate. /// /// For debuggability, you can set an explicit name for a singleton. This name only shows up the /// the debugger and is not referencable from other code. See example below. |