aboutsummaryrefslogtreecommitdiff
path: root/embassy-boot/src
diff options
context:
space:
mode:
authorBadr Bouslikhin <[email protected]>2024-02-07 14:37:38 +0100
committerBadr Bouslikhin <[email protected]>2024-02-07 14:37:38 +0100
commite391b9b74c95090548c50b6f05a859f0220c42f9 (patch)
tree0fee40918a9a7a9e5aa984058d226abe81dd8a47 /embassy-boot/src
parent634c409c55c71ca2871cd05d4a7754654926db48 (diff)
docs(boot): ignore partial non-compilable example in rustdoc
Diffstat (limited to 'embassy-boot/src')
-rw-r--r--embassy-boot/src/boot_loader.rs2
-rw-r--r--embassy-boot/src/firmware_updater/blocking.rs2
-rw-r--r--embassy-boot/src/firmware_updater/mod.rs2
3 files changed, 3 insertions, 3 deletions
diff --git a/embassy-boot/src/boot_loader.rs b/embassy-boot/src/boot_loader.rs
index 2a5f024f6..ca1a1b10c 100644
--- a/embassy-boot/src/boot_loader.rs
+++ b/embassy-boot/src/boot_loader.rs
@@ -79,7 +79,7 @@ impl<'a, ACTIVE: NorFlash, DFU: NorFlash, STATE: NorFlash>
79 /// A `BootLoaderConfig` instance with `BlockingPartition` instances for the active, DFU, and state partitions. 79 /// A `BootLoaderConfig` instance with `BlockingPartition` instances for the active, DFU, and state partitions.
80 /// 80 ///
81 /// # Example 81 /// # Example
82 /// ```no_run 82 /// ```ignore
83 /// // Assume `active_flash`, `dfu_flash`, and `state_flash` all share the same flash memory interface. 83 /// // Assume `active_flash`, `dfu_flash`, and `state_flash` all share the same flash memory interface.
84 /// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions(); 84 /// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions();
85 /// let flash = Mutex::new(RefCell::new(layout.bank1_region)); 85 /// let flash = Mutex::new(RefCell::new(layout.bank1_region));
diff --git a/embassy-boot/src/firmware_updater/blocking.rs b/embassy-boot/src/firmware_updater/blocking.rs
index a29efabf0..4044871f0 100644
--- a/embassy-boot/src/firmware_updater/blocking.rs
+++ b/embassy-boot/src/firmware_updater/blocking.rs
@@ -41,7 +41,7 @@ impl<'a, DFU: NorFlash, STATE: NorFlash>
41 /// A `FirmwareUpdaterConfig` instance with `BlockingPartition` instances for the DFU, and state partitions. 41 /// A `FirmwareUpdaterConfig` instance with `BlockingPartition` instances for the DFU, and state partitions.
42 /// 42 ///
43 /// # Example 43 /// # Example
44 /// ```no_run 44 /// ```ignore
45 /// // Assume `dfu_flash`, and `state_flash` share the same flash memory interface. 45 /// // Assume `dfu_flash`, and `state_flash` share the same flash memory interface.
46 /// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions(); 46 /// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions();
47 /// let flash = Mutex::new(RefCell::new(layout.bank1_region)); 47 /// let flash = Mutex::new(RefCell::new(layout.bank1_region));
diff --git a/embassy-boot/src/firmware_updater/mod.rs b/embassy-boot/src/firmware_updater/mod.rs
index 4814786bf..4c4f4f10b 100644
--- a/embassy-boot/src/firmware_updater/mod.rs
+++ b/embassy-boot/src/firmware_updater/mod.rs
@@ -8,7 +8,7 @@ use embedded_storage::nor_flash::{NorFlashError, NorFlashErrorKind};
8/// Firmware updater flash configuration holding the two flashes used by the updater 8/// Firmware updater flash configuration holding the two flashes used by the updater
9/// 9///
10/// If only a single flash is actually used, then that flash should be partitioned into two partitions before use. 10/// If only a single flash is actually used, then that flash should be partitioned into two partitions before use.
11/// The easiest way to do this is to use [`FirmwareUpdaterConfig::from_linkerfile`] or [`FirmwareUpdaterConfig::from_linkerfile_blocking`] which will partition 11/// The easiest way to do this is to use [`FirmwareUpdaterConfig::from_linkerfile_blocking`] or [`FirmwareUpdaterConfig::from_linkerfile_blocking`] which will partition
12/// the provided flash according to symbols defined in the linkerfile. 12/// the provided flash according to symbols defined in the linkerfile.
13pub struct FirmwareUpdaterConfig<DFU, STATE> { 13pub struct FirmwareUpdaterConfig<DFU, STATE> {
14 /// The dfu flash partition 14 /// The dfu flash partition