Skip to content

uefi: improve doc for device path construction #1800

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 30, 2025
Merged

uefi: improve doc for device path construction #1800

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 23 additions & 5 deletions uefi/src/proto/device_path/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@
//!
//! # Types
//!
//! To represent device paths, this module provides several types:
//! This module defines several types used to represent device paths.
//! For constructing device paths, see the [`build`] module.
//!
//! * [`DevicePath`] is the root type that represents a full device
//! path, containing one or more device path instance. It ends with an
Expand Down Expand Up @@ -80,6 +81,13 @@
//! Note: the API provided by this module is currently mostly limited to
//! reading existing device paths rather than constructing new ones.
//!
//! # Submodules
//!
//! - utilities to construct device paths: [`build`]
//! - utilities to transform device paths to a textual representation: [`text`]
//! - DevicePathUtilities protocol:: [`util`]
//!
//!
//! [`END_ENTIRE`]: DeviceSubType::END_ENTIRE
//! [`END_INSTANCE`]: DeviceSubType::END_INSTANCE
//! [`Protocol`]: crate::proto::Protocol
Expand Down Expand Up @@ -343,9 +351,14 @@ impl<'a> TryFrom<&'a [u8]> for &'a DevicePathNode {
}
}

/// A single device path instance that ends with either an [`END_INSTANCE`]
/// or [`END_ENTIRE`] node. Use [`DevicePath::instance_iter`] to get the
/// path instances in a [`DevicePath`].
/// A single device path instance within a fully-qualified [`DevicePath`], which
/// ends with either an [`END_INSTANCE`] or [`END_ENTIRE`] node.
///
/// An instance is one of possibly multiple complete route to the target, e.g.,
/// a file can be located via network device one or two.
///
/// Use [`DevicePath::instance_iter`] to get the path instances in a
/// [`DevicePath`].
///
/// See the [module-level documentation] for more details.
///
Expand Down Expand Up @@ -411,11 +424,16 @@ impl ToOwned for DevicePathInstance {
}
}

/// High-level representation of the UEFI [device path protocol].
/// High-level representation of the UEFI [device path protocol], often simply
/// referred to as "device path".
///
/// This type represents an entire device path, possibly consisting of multiple
/// [`DevicePathInstance`]s and [`DevicePathNode`]s.
///
/// Further, this Rust type is a DST and therefore typically exists as reference
/// to parse underlying data correspondingly. To get an owned device path, you
/// can use [`DevicePath::to_owned`].
///
/// See the [module-level documentation] for more details.
///
/// # Usage
Expand Down
Loading