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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

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
11 changes: 10 additions & 1 deletion 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,9 @@
//!
//! # Types
//!
//! To represent device paths, this module provides several types:
//! To represent device paths, this module provides several types, which are
//! listed in the following. To construct device paths, please head to the
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
//! listed in the following. To construct device paths, please head to the
//! listed in the following sections. To construct device paths, please head to 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 +82,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
Loading