Fix clippy::doc_lazy_continuation lints

src/engine/engine.rs

@@ -44,11 +44,11 @@ pub trait KeyActions {
     ///
     /// Successful return values:
     /// * `Ok(MappingCreateAction::Identity)`: The key was already in the keyring
-    /// with the appropriate key description and key data.
+    ///   with the appropriate key description and key data.
     /// * `Ok(MappingCreateAction::Created(_))`: The key was newly added to the
-    /// keyring.
+    ///   keyring.
     /// * `Ok(MappingCreateAction::Changed)`: The key description was already present
-    /// in the keyring but the key data was updated.
+    ///   in the keyring but the key data was updated.
     fn set(
         &self,
         key_desc: &KeyDescription,
@@ -133,11 +133,11 @@ pub trait Pool: Debug + Send + Sync {
     /// Returns a list of the the block devices that were actually added as cache
     /// devices. In practice, this will have three types of return values:
     /// * An error if the cache has already been initialized with a different set
-    /// of block devices.
+    ///   of block devices.
     /// * `SetCreateAction::Identity` if the cache has already been initialized with
-    /// the same set of block devices.
+    ///   the same set of block devices.
     /// * `SetCreateAction::Created` containing all provided block devices if the
-    /// cache has not yet been initialized.
+    ///   cache has not yet been initialized.
     ///
     /// This ensures the contract of providing a truly idempotent API as the cache
     /// can only be initialized once and if an attempt is made to initialize it

src/engine/strat_engine/backstore/backstore/v1.rs

@@ -183,9 +183,9 @@ impl Backstore {
     ///
     /// Precondition:
     ///   * key_description.is_some() -> every StratBlockDev in datadevs has a
-    ///   key description and that key description == key_description
+    ///     key description and that key description == key_description
     ///   * key_description.is_none() -> no StratBlockDev in datadevs has a
-    ///   key description.
+    ///     key description.
     ///   * no StratBlockDev in cachedevs has a key description
     ///
     /// Postcondition:
@@ -625,7 +625,7 @@ impl Backstore {
     /// * Ok(Some(uuid)) provides the uuid of the changed blockdev
     /// * Ok(None) is returned if the blockdev was unchanged
     /// * Err(StratisError::Engine(_)) is returned if the UUID
-    /// does not correspond to a blockdev
+    ///   does not correspond to a blockdev
     pub fn set_blockdev_user_info(
         &mut self,
         uuid: DevUuid,
@@ -676,9 +676,9 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the binding was performed.
     /// * Returns Ok(false) if the binding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if an inconsistency was found in the metadata across pools
-    /// or binding failed.
+    ///   or binding failed.
     pub fn bind_clevis(&mut self, pin: &str, clevis_info: &Value) -> StratisResult<bool> {
         let encryption_info = match pool_enc_to_enc!(self.encryption_info()) {
             Some(ei) => ei,
@@ -733,9 +733,9 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the unbinding was performed.
     /// * Returns Ok(false) if the unbinding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if an inconsistency was found in the metadata across pools
-    /// or unbinding failed.
+    ///   or unbinding failed.
     pub fn unbind_clevis(&mut self) -> StratisResult<bool> {
         let encryption_info = match pool_enc_to_enc!(self.encryption_info()) {
             Some(ei) => ei,
@@ -762,9 +762,9 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the binding was performed.
     /// * Returns Ok(false) if the binding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if an inconsistency was found in the metadata across pools
-    /// or binding failed.
+    ///   or binding failed.
     pub fn bind_keyring(&mut self, key_desc: &KeyDescription) -> StratisResult<bool> {
         let encryption_info = match pool_enc_to_enc!(self.encryption_info()) {
             Some(ei) => ei,
@@ -817,9 +817,9 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the unbinding was performed.
     /// * Returns Ok(false) if the unbinding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if an inconsistency was found in the metadata across pools
-    /// or unbinding failed.
+    ///   or unbinding failed.
     pub fn unbind_keyring(&mut self) -> StratisResult<bool> {
         let encryption_info = match pool_enc_to_enc!(self.encryption_info()) {
             Some(ei) => ei,

src/engine/strat_engine/backstore/backstore/v2.rs

@@ -292,9 +292,9 @@ impl Backstore {
     ///
     /// Precondition:
     ///   * key_description.is_some() -> every StratBlockDev in datadevs has a
-    ///   key description and that key description == key_description
+    ///     key description and that key description == key_description
     ///   * key_description.is_none() -> no StratBlockDev in datadevs has a
-    ///   key description.
+    ///     key description.
     ///   * no StratBlockDev in cachedevs has a key description
     ///
     /// Postcondition:
@@ -874,7 +874,7 @@ impl Backstore {
     /// * Ok(Some(uuid)) provides the uuid of the changed blockdev
     /// * Ok(None) is returned if the blockdev was unchanged
     /// * Err(StratisError::Engine(_)) is returned if the UUID
-    /// does not correspond to a blockdev
+    ///   does not correspond to a blockdev
     pub fn set_blockdev_user_info(
         &mut self,
         uuid: DevUuid,
@@ -916,7 +916,7 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the binding was performed.
     /// * Returns Ok(false) if the binding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if binding failed.
     pub fn bind_clevis(&mut self, pin: &str, clevis_info: &Value) -> StratisResult<bool> {
         let handle = self
@@ -961,7 +961,7 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the unbinding was performed.
     /// * Returns Ok(false) if the unbinding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if unbinding failed.
     pub fn unbind_clevis(&mut self) -> StratisResult<bool> {
         let handle = self
@@ -987,7 +987,7 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the binding was performed.
     /// * Returns Ok(false) if the binding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if binding failed.
     pub fn bind_keyring(&mut self, key_desc: &KeyDescription) -> StratisResult<bool> {
         let handle = self
@@ -1022,7 +1022,7 @@ impl Backstore {
     ///
     /// * Returns Ok(true) if the unbinding was performed.
     /// * Returns Ok(false) if the unbinding had already been previously performed and
-    /// nothing was changed.
+    ///   nothing was changed.
     /// * Returns Err(_) if unbinding failed.
     pub fn unbind_keyring(&mut self) -> StratisResult<bool> {
         let handle = self

src/engine/strat_engine/backstore/blockdev/mod.rs

@@ -91,7 +91,7 @@ pub trait InternalBlockDev {
     ///
     /// Returns:
     /// * `None` if the size hasn't changed or is equal to the current size recorded
-    /// in the metadata.
+    ///   in the metadata.
     /// * Otherwise, `Some(_)`
     fn calc_new_size(&self) -> StratisResult<Option<Sectors>>;
 

src/engine/strat_engine/backstore/blockdev/v1.rs

@@ -103,6 +103,7 @@ impl StratBlockDev {
     /// - hardware_info: identifying information in the hardware
     /// - key_description: optional argument enabling encryption using
     ///                    the specified key in the kernel keyring
+    ///
     /// Returns an error if it is impossible to allocate all segments on the
     /// device.
     /// NOTE: It is possible that the actual device size is greater than
@@ -226,9 +227,9 @@ impl StratBlockDev {
     ///
     /// Returns:
     /// * Some(Some(_)) if the pool is encrypted and the pool name is set in the
-    /// metadata
+    ///   metadata
     /// * Some(None) if the pool is encrypted and the pool name is not set in the
-    /// metadata
+    ///   metadata
     /// * None if the pool is not encrypted
     #[allow(clippy::option_option)]
     pub fn pool_name(&self) -> Option<Option<&Name>> {

src/engine/strat_engine/backstore/blockdev/v2.rs

@@ -86,6 +86,7 @@ impl StratBlockDev {
     /// - hardware_info: identifying information in the hardware
     /// - key_description: optional argument enabling encryption using
     ///                    the specified key in the kernel keyring
+    ///
     /// Returns an error if it is impossible to allocate all segments on the
     /// device.
     /// NOTE: It is possible that the actual device size is greater than

src/engine/strat_engine/backstore/range_alloc.rs

@@ -19,7 +19,7 @@ use crate::{
 /// It enforces some invariants:
 /// * No 0 length segment
 /// * No contiguous segments; if two segments would be contiguous they are
-/// coalesced into a single segment.
+///   coalesced into a single segment.
 /// * No overlapping segments
 /// * No segments that extend beyond limit
 #[derive(Debug, Clone)]

src/engine/strat_engine/crypt/shared.rs

@@ -180,7 +180,7 @@ pub fn device_from_physical_path(physical_path: &Path) -> StratisResult<Option<C
 /// This method returns:
 /// * Ok(Some(_)) if a Clevis token was detected
 /// * Ok(None) if no token in the Clevis slot was detected or a token was detected
-/// but does not appear to be a Clevis token
+///   but does not appear to be a Clevis token
 /// * Err(_) if the token appears to be a Clevis token but is malformed in some way
 pub fn clevis_info_from_metadata(
     device: &mut CryptDevice,

src/engine/strat_engine/keys.rs

@@ -187,10 +187,10 @@ fn set_key(
 ///
 /// Successful return values:
 /// * `Ok(MappingCreateAction::Identity)`: The key was already in the keyring with the
-/// appropriate key description and key data.
+///   appropriate key description and key data.
 /// * `Ok(MappingCreateAction::Created(()))`: The key was newly added to the keyring.
 /// * `Ok(MappingCreateAction::ValueChanged(()))`: The key description was already present
-/// in the keyring but the key data was updated.
+///   in the keyring but the key data was updated.
 fn set_key_idem(
     key_desc: &KeyDescription,
     key_data: SizedKeyMemory,

src/engine/strat_engine/liminal/identify.rs

@@ -597,7 +597,7 @@ mod tests {
         /// recognized.
         ///
         /// * Verify that the physical paths are recognized as LUKS devices
-        /// belonging to Stratis.
+        ///   belonging to Stratis.
         /// * Verify that the physical paths are not recognized as Stratis devices.
         /// * Verify that the metadata paths are recognized as Stratis devices.
         fn test_process_luks_device_initialized(paths: &[&Path]) {

src/engine/strat_engine/metadata/mda.rs

@@ -264,9 +264,9 @@ impl MDARegions {
     #[cfg(test)]
     /// An invariant on MDARegions structs.
     /// 1. If an MDAHeader in the regions is not None, then its used
-    /// attribute must be greater than 0.
+    ///    attribute must be greater than 0.
     /// 2. If an MDAHeader in the regions is not None, then its used
-    /// attribute must be no greater than the region allocated for it.
+    ///    attribute must be no greater than the region allocated for it.
     pub fn invariant(&self) {
         let space_for_data = self.region_size.data_size().bytes();
         for mda in self.mda_headers.iter().flatten() {

src/engine/strat_engine/metadata/sizes.rs

@@ -63,6 +63,7 @@ pub mod mda_size {
     /// It is constructed in one of two ways:
     /// * By reading a value from a device in constructing a StaticHeader
     /// * MDARegionSize::mda_size
+    ///
     /// Since only a valid MDASize can be constructed, only a valid MDASize
     /// can be written. An error on reading ought to be detected by
     /// checksums.
@@ -98,6 +99,7 @@ pub mod mda_size {
     /// Values of this type are created by one of two methods:
     /// * MDASize::region_size
     /// * MDADataSize::region_size
+    ///
     /// Since an MDADataSize is always at least the minimum required by the
     /// design specification, MDADataSize::region_size() always yields a
     /// value of at least the minimum required size.

src/engine/structures/lock.rs

@@ -145,7 +145,7 @@ where
     U: AsUuid,
 {
     /// * Asserts that tasks performing an actions either are performing an action immediately
-    /// after being spawned or are in the list of woken tasks.
+    ///   after being spawned or are in the list of woken tasks.
     ///
     /// NOTE: This method has the side effect of clearing a woken waiter if it is the waiter that
     /// is currently acquiring the lock.
@@ -159,9 +159,9 @@ where
     }
 
     /// * Asserts that tasks performing an actions either are performing an action immediately
-    /// after being spawned or are in the list of woken tasks.
+    ///   after being spawned or are in the list of woken tasks.
     /// * Asserts that the current task never conflicts with tasks that have been woken but
-    /// not processed yet.
+    ///   not processed yet.
     ///
     /// NOTE: This method has the side effect of clearing a woken waiter if it is the waiter that
     /// is currently acquiring the lock.
@@ -291,7 +291,7 @@ where
 
     /// Returns true if the current request should be put in the wait queue.
     /// * Always returns false if the index for the given request is in the record of woken
-    /// tasks.
+    ///   tasks.
     /// * Otherwise, returns true if either of the following conditions are met:
     ///   * The lock already has a conflicting acquisition.
     ///   * The request conflicts with any tasks that have already been woken up.

src/engine/types/mod.rs

@@ -205,7 +205,7 @@ impl fmt::Display for Name {
 /// This report may be fetched through `Report::engine_state_report()`.
 ///
 /// * `ErroredPoolDevices` returns the state of devices that caused an error while
-/// attempting to reconstruct a pool.
+///   attempting to reconstruct a pool.
 pub enum ReportType {
     StoppedPools,
 }

stratisd_proc_macros/src/lib.rs

@@ -283,7 +283,7 @@ fn process_item(mut item: Item) -> Item {
 /// implementations. It provides two facilities:
 /// * checking if the error returned should cause the pool to refuse mutating actions.
 /// * returning an error if the method called would cause a mutating action to occur if
-/// the pool cannot accept mutating actions.
+///   the pool cannot accept mutating actions.
 ///
 /// This macro should be applied to `impl` items only.
 #[proc_macro_attribute]