mirror of
https://github.com/embassy-rs/embassy.git
synced 2024-11-21 14:22:33 +00:00
docs(boot): ignore partial non-compilable example in rustdoc
This commit is contained in:
parent
634c409c55
commit
e391b9b74c
@ -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.
|
||||
///
|
||||
/// # Example
|
||||
/// ```no_run
|
||||
/// ```ignore
|
||||
/// // 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 flash = Mutex::new(RefCell::new(layout.bank1_region));
|
||||
|
@ -41,7 +41,7 @@ impl<'a, DFU: NorFlash, STATE: NorFlash>
|
||||
/// A `FirmwareUpdaterConfig` instance with `BlockingPartition` instances for the DFU, and state partitions.
|
||||
///
|
||||
/// # Example
|
||||
/// ```no_run
|
||||
/// ```ignore
|
||||
/// // Assume `dfu_flash`, and `state_flash` share the same flash memory interface.
|
||||
/// let layout = Flash::new_blocking(p.FLASH).into_blocking_regions();
|
||||
/// let flash = Mutex::new(RefCell::new(layout.bank1_region));
|
||||
|
@ -8,7 +8,7 @@ use embedded_storage::nor_flash::{NorFlashError, NorFlashErrorKind};
|
||||
/// 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.
|
||||
/// 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.
|
||||
pub struct FirmwareUpdaterConfig<DFU, STATE> {
|
||||
/// The dfu flash partition
|
||||
|
Loading…
Reference in New Issue
Block a user