Skip to content

Commit

Permalink
fix doc build
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewjstone committed Oct 25, 2023
1 parent 56a614f commit 5e74730
Show file tree
Hide file tree
Showing 7 changed files with 11 additions and 10 deletions.
1 change: 1 addition & 0 deletions illumos-utils/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

//! Wrappers around illumos-specific commands.
#[allow(unused)]
use std::sync::atomic::{AtomicBool, Ordering};

use cfg_if::cfg_if;
Expand Down
4 changes: 2 additions & 2 deletions nexus/src/app/background/common.rs
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ pub struct Driver {
///
/// This is returned by [`Driver::register()`] to identify the corresponding
/// background task. It's then accepted by functions like
/// [`Driver::activate()`] and [`Driver::status()`] to identify the task.
/// [`Driver::activate()`] and [`Driver::task_status()`] to identify the task.
#[derive(Clone, Debug, Ord, PartialOrd, PartialEq, Eq)]
pub struct TaskHandle(String);

Expand Down Expand Up @@ -277,7 +277,7 @@ impl Driver {
/// Enumerate all registered background tasks
///
/// This is aimed at callers that want to get the status of all background
/// tasks. You'd call [`Driver::status()`] with each of the items produced
/// tasks. You'd call [`Driver::task_status()`] with each of the items produced
/// by the iterator.
pub fn tasks(&self) -> impl Iterator<Item = &TaskHandle> {
self.tasks.keys()
Expand Down
2 changes: 1 addition & 1 deletion sled-agent/src/services.rs
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
//! Sled-local service management.
//!
//! For controlling zone-based storage services, refer to
//! [sled_storage:manager::StorageManager].
//! [sled_storage::manager::StorageManager].
//!
//! For controlling virtual machine instances, refer to
//! [crate::instance_manager::InstanceManager].
Expand Down
2 changes: 1 addition & 1 deletion sled-agent/src/storage_monitor.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// License, v. 2.0. If a copy of the MPL was not distributed with this
// file, You can obtain one at https://mozilla.org/MPL/2.0/.

//! A task that listens for storage events from [`sled_storage::StorageMonitor`]
//! A task that listens for storage events from [`sled_storage::manager::StorageManager`]
//! and dispatches them to other parst of the bootstrap agent and sled agent
//! code.
Expand Down
6 changes: 3 additions & 3 deletions sled-hardware/src/disk.rs
Original file line number Diff line number Diff line change
Expand Up @@ -118,9 +118,9 @@ impl DiskPaths {
/// A disk which has been observed by monitoring hardware.
///
/// No guarantees are made about the partitions which exist within this disk.
/// This exists as a distinct entity from [Disk] because it may be desirable to
/// monitor for hardware in one context, and conform disks to partition layouts
/// in a different context.
/// This exists as a distinct entity from `Disk` in `sled-storage` because it
/// may be desirable to monitor for hardware in one context, and conform disks
/// to partition layouts in a different context.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct UnparsedDisk {
paths: DiskPaths,
Expand Down
4 changes: 2 additions & 2 deletions sled-storage/src/resources.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ const ZONE_BUNDLE_DIRECTORY: &str = "zone";

/// Storage related resources: disks and zpools
///
/// This state is internal to the [`crate::StorageManager`] task. Clones
/// This state is internal to the [`crate::manager::StorageManager`] task. Clones
/// of this state can be retrieved by requests to the `StorageManager` task
/// from the [`crate::StorageManagerHandle`]. This state is not `Sync`, and
/// from the [`crate::manager::StorageHandle`]. This state is not `Sync`, and
/// as such does not require any mutexes. However, we do expect to share it
/// relatively frequently, and we want copies of it to be as cheaply made
/// as possible. So any large state is stored inside `Arc`s. On the other
Expand Down
2 changes: 1 addition & 1 deletion wicketd/src/artifacts/extracted_artifacts.rs
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ impl ExtractedArtifacts {
///
/// As the returned file is written to, the data will be hashed; once
/// writing is complete, call [`ExtractedArtifacts::store_tempfile()`] to
/// persist the temporary file into an [`ExtractedArtifactDataHandle()`].
/// persist the temporary file into an [`ExtractedArtifactDataHandle`].
pub(super) fn new_tempfile(
&self,
) -> Result<HashingNamedUtf8TempFile, RepositoryError> {
Expand Down

0 comments on commit 5e74730

Please sign in to comment.