Skip to content

Commit 1dd1003

Browse files
committed
Update docs
1 parent 0ab43f0 commit 1dd1003

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/lib.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -122,21 +122,18 @@
122122
//! - [`msp430-rt`](https://crates.io/crates/msp430-rt) v0.4.x
123123
//! - [`vcell`](https://crates.io/crates/vcell) v0.1.x
124124
//!
125-
//! If the `--nightly` flag is provided to `svd2rust`, then `portable-atomic` v0.3.15 is also needed.
126-
//! Furthermore the "device" feature of `msp430-rt` must be enabled when the `rt` feature is
125+
//! The "device" feature of `msp430-rt` must be enabled when the `rt` feature is
127126
//! enabled. The `Cargo.toml` of the device crate will look like this:
128127
//!
129128
//! ``` toml
130129
//! [dependencies]
131130
//! critical-section = { version = "1.0", optional = true }
132131
//! msp430 = "0.4.0"
133-
//! portable-atomic = "0.3.15" # Only when using the --nightly flag
134132
//! msp430-rt = { version = "0.4.0", optional = true }
135133
//! vcell = "0.1.0"
136134
//!
137135
//! [features]
138136
//! rt = ["msp430-rt/device"]
139-
//! unstable = ["portable-atomic"]
140137
//! ```
141138
//!
142139
//! ## Other targets
@@ -492,13 +489,16 @@
492489
//! The `--nightly` flag can be passed to `svd2rust` to enable features in the generated api that are only available to a nightly
493490
//! compiler. The following features are gated by the `--nightly` flag:
494491
//!
495-
//! ### MSP430
492+
//! ### Atomics
496493
//!
497494
//! Extends the register API with operations to atomically set, clear, and toggle specific bits.
498495
//! The atomic operations allow limited modification of register bits without read-modify-write
499496
//! sequences. As such, they can be concurrently called on different bits in the same register
500497
//! without data races.
501498
//!
499+
//! `portable-atomic` v0.3.15 must be added to the dependencies, with default features off if
500+
//! possible to disable the `fallback` feature.
501+
//!
502502
//! Usage examples:
503503
//!
504504
//! ```ignore

0 commit comments

Comments
 (0)