Skip to content

Commit a7a807a

Browse files
committed
Make the docs build
Turns out there were some broken links.
1 parent 1463915 commit a7a807a

File tree

4 files changed

+21
-15
lines changed

4 files changed

+21
-15
lines changed

src/mpmc.rs

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
//! A fixed capacity Multiple-Producer Multiple-Consumer (MPMC) lock-free queue
22
//!
33
//! NOTE: This module is not available on targets that do *not* support CAS operations and are not
4-
//! emulated by the [`atomic_polyfill`] crate (e.g., MSP430).
4+
//! emulated by the [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill) crate (e.g.,
5+
//! MSP430).
56
//!
67
//! # Example
78
//!
@@ -75,9 +76,11 @@
7576
//! # Portability
7677
//!
7778
//! This module requires CAS atomic instructions which are not available on all architectures
78-
//! (e.g. ARMv6-M (`thumbv6m-none-eabi`) and MSP430 (`msp430-none-elf`)). These atomics can be emulated
79-
//! however with [`atomic_polyfill`], which is enabled with the `cas` feature and is enabled by default
80-
//! for `thumbv6m-none-eabi` and `riscv32` targets. MSP430 is currently not supported by [`atomic_polyfill`].
79+
//! (e.g. ARMv6-M (`thumbv6m-none-eabi`) and MSP430 (`msp430-none-elf`)). These atomics can be
80+
//! emulated however with [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill), which is
81+
//! enabled with the `cas` feature and is enabled by default for `thumbv6m-none-eabi` and `riscv32`
82+
//! targets. MSP430 is currently not supported by
83+
//! [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill).
8184
//!
8285
//! # References
8386
//!

src/pool/mod.rs

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
//! A heap-less, interrupt-safe, lock-free memory pool (\*)
22
//!
33
//! NOTE: This module is not available on targets that do *not* support CAS operations and are not
4-
//! emulated by the [`atomic_polyfill`] crate (e.g., MSP430).
4+
//! emulated by the [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill) crate (e.g.,
5+
//! MSP430).
56
//!
67
//! (\*) Currently, the implementation is only lock-free *and* `Sync` on ARMv6, ARMv7-{A,R,M} & ARMv8-M
78
//! devices
@@ -64,10 +65,12 @@
6465
//! on the target architecture (see section on ['Soundness'](#soundness) for more information). For
6566
//! this reason, `Pool` only implements `Sync` when compiling for some ARM cores.
6667
//!
67-
//! This module requires CAS atomic instructions which are not available on all architectures
68-
//! (e.g. ARMv6-M (`thumbv6m-none-eabi`) and MSP430 (`msp430-none-elf`)). These atomics can be emulated
69-
//! however with [`atomic_polyfill`], which is enabled with the `cas` feature and is enabled by default
70-
//! for `thumbv6m-none-eabi` and `riscv32` targets. MSP430 is currently not supported by [`atomic_polyfill`].
68+
//! This module requires CAS atomic instructions which are not available on all architectures (e.g.
69+
//! ARMv6-M (`thumbv6m-none-eabi`) and MSP430 (`msp430-none-elf`)). These atomics can be emulated
70+
//! however with [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill), which is enabled
71+
//! with the `cas` feature and is enabled by default for `thumbv6m-none-eabi` and `riscv32` targets.
72+
//! MSP430 is currently not supported by
73+
//! [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill).
7174
//!
7275
//! # Soundness
7376
//!

src/spsc.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
//! Implementation based on <https://www.codeproject.com/Articles/43510/Lock-Free-Single-Producer-Single-Consumer-Circular>
44
//!
55
//! NOTE: This module is not available on targets that do *not* support atomic loads and are not
6-
//! supported by [`atomic_polyfill`]. (e.g., MSP430).
6+
//! supported by [`atomic_polyfill`](https://crates.io/crates/atomic-polyfill). (e.g., MSP430).
77
//!
88
//! # Examples
99
//!

src/vec.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -624,13 +624,13 @@ impl<T, const N: usize> Vec<T, N> {
624624
/// shifting all elements after it to the left.
625625
///
626626
/// Note: Because this shifts over the remaining elements, it has a
627-
/// worst-case performance of *O*(*n*). If you don't need the order of elements
628-
/// to be preserved, use [`swap_remove`] instead. If you'd like to remove
629-
/// elements from the beginning of the `Vec`, consider using
630-
/// [`VecDeque::pop_front`] instead.
627+
/// worst-case performance of *O*(*n*). If you don't need the order of
628+
/// elements to be preserved, use [`swap_remove`] instead. If you'd like to
629+
/// remove elements from the beginning of the `Vec`, consider using
630+
/// [`Deque::pop_front`] instead.
631631
///
632632
/// [`swap_remove`]: Vec::swap_remove
633-
/// [`VecDeque::pop_front`]: crate::VecDeque::pop_front
633+
/// [`Deque::pop_front`]: crate::Deque::pop_front
634634
///
635635
/// # Panics
636636
///

0 commit comments

Comments
 (0)