nordic-dev.net/embassy
2
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2024-11-21 22:32:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(boot): ignore partial non-compilable example in rustdoc

Browse Source
This commit is contained in:
Badr Bouslikhin 2024-02-07 14:37:38 +01:00
parent 634c409c55
commit e391b9b74c
No known key found for this signature in database
GPG Key ID: 3B081233DD4DE99B
3 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
embassy-boot/src/boot_loader.rs
View File

@ -79,7 +79,7 @@ impl<'a, ACTIVE: NorFlash, DFU: NorFlash, STATE: NorFlash>
/// A `BootLoaderConfig` instance with `BlockingPartition` instances for the active, DFU, and state partitions. /// A `BootLoaderConfig` instance with `BlockingPartition` instances for the active, DFU, and state partitions.
/// ///
/// # Example /// # Example
/// ```no_run /// ```ignore
/// // Assume `active_flash`, `dfu_flash`, and `state_flash` all share the same flash memory interface. /// // Assume `active_flash`, `dfu_flash`, and `state_flash` all share the same flash memory interface.
/// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions(); /// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions();
/// let flash = Mutex::new(RefCell::new(layout.bank1_region)); /// let flash = Mutex::new(RefCell::new(layout.bank1_region));

2
embassy-boot/src/firmware_updater/blocking.rs
View File

@ -41,7 +41,7 @@ impl<'a, DFU: NorFlash, STATE: NorFlash>
/// A `FirmwareUpdaterConfig` instance with `BlockingPartition` instances for the DFU, and state partitions. /// A `FirmwareUpdaterConfig` instance with `BlockingPartition` instances for the DFU, and state partitions.
/// ///
/// # Example /// # Example
/// ```no_run /// ```ignore
/// // Assume `dfu_flash`, and `state_flash` share the same flash memory interface. /// // Assume `dfu_flash`, and `state_flash` share the same flash memory interface.
/// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions(); /// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions();
/// let flash = Mutex::new(RefCell::new(layout.bank1_region)); /// let flash = Mutex::new(RefCell::new(layout.bank1_region));

2
embassy-boot/src/firmware_updater/mod.rs
View File

@ -8,7 +8,7 @@ use embedded_storage::nor_flash::{NorFlashError, NorFlashErrorKind};
/// Firmware updater flash configuration holding the two flashes used by the updater /// Firmware updater flash configuration holding the two flashes used by the updater
/// ///
/// If only a single flash is actually used, then that flash should be partitioned into two partitions before use. /// If only a single flash is actually used, then that flash should be partitioned into two partitions before use.
/// The easiest way to do this is to use [`FirmwareUpdaterConfig::from_linkerfile`] or [`FirmwareUpdaterConfig::from_linkerfile_blocking`] which will partition /// The easiest way to do this is to use [`FirmwareUpdaterConfig::from_linkerfile_blocking`] or [`FirmwareUpdaterConfig::from_linkerfile_blocking`] which will partition
/// the provided flash according to symbols defined in the linkerfile. /// the provided flash according to symbols defined in the linkerfile.
pub struct FirmwareUpdaterConfig<DFU, STATE> { pub struct FirmwareUpdaterConfig<DFU, STATE> {
/// The dfu flash partition /// The dfu flash partition