Skip to content

docs: Fix partition type rendering in docs #662

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
frhuelsz merged 2 commits into from
May 26, 2026
Merged

docs: Fix partition type rendering in docs #662

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
979f7ca
FIx partition type rendering in docs
frhuelsz May 26, 2026
4e09ec3
Potential fix for pull request finding
frhuelsz May 26, 2026
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
17 changes: 11 additions & 6 deletions crates/trident_api/src/config/host/storage/partitions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,14 +269,19 @@ impl From<PartitionType> for DiscoverablePartitionType {
}

impl Display for PartitionType {
/// Formats known partition types using systemd-repart names and unknown
/// partition types as `unknown(<uuid>)` to preserve UUID visibility.
/// Formats partition types using systemd-repart names for regular `{}`
/// output; unknown partition types print as `unknown`, or as
/// `unknown(<uuid>)` when using alternate `{:#}` formatting.
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
if let Self::Unknown(uuid) = self {
write!(f, "unknown({uuid})")
} else {
write!(f, "{}", self.to_sdrepart_part_type())
// On alternate format, show unknown partition types as `unknown(<uuid>)`.
if f.alternate() {
if let Self::Unknown(uuid) = self {
return write!(f, "unknown({uuid})");
Comment on lines 271 to +279
}
}

// On regular format, show the partition type as a simple string.
write!(f, "{}", self.to_sdrepart_part_type())
}
}

Expand Down
10 changes: 5 additions & 5 deletions crates/trident_api/src/config/host/storage/storage_graph/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ pub enum StorageGraphBuildError {

#[error(
"Referrer {} of kind '{kind}' references partition \
'{partition_id}' of invalid type '{partition_type}', acceptable \
'{partition_id}' of invalid type '{partition_type:#}', acceptable \
types are: {valid_types}",
pretty_node_id(.node_identifier)
Comment thread
frhuelsz marked this conversation as resolved.
)]
Expand All @@ -97,7 +97,7 @@ pub enum StorageGraphBuildError {

#[error(
"Referrer {} of kind '{kind}' has a special reference of kind '{special_ref_kind}' which \
references partition '{partition_id}' of invalid type '{partition_type}', acceptable \
references partition '{partition_id}' of invalid type '{partition_type:#}', acceptable \
types are: {valid_types}",
pretty_node_id(.node_identifier)
)]
Expand Down Expand Up @@ -175,9 +175,9 @@ pub enum StorageGraphBuildError {
},

#[error(
"Verity device '{node_id}' has a data device with partition type '{data_dev_partition_type}', \
which expects the hash device partition type to be '{expected_type}', but the type is \
'{hash_dev_partition_type}'."
"Verity device '{node_id}' has a data device with partition type '{data_dev_partition_type:#}', \
which expects the hash device partition type to be '{expected_type:#}', but the type is \
'{hash_dev_partition_type:#}'."
)]
InvalidVerityHashPartitionType {
node_id: String,
Expand Down
30 changes: 15 additions & 15 deletions docs/Reference/Host-Configuration/Storage-Rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,21 +239,21 @@ The following table lists the expected mount points for each partition type, as
defined in the [Discoverable Partition Specification
(DPS)](https://uapi-group.org/specifications/specs/discoverable_partitions_specification/):

| Partition Type | Valid Mount Paths |
| --------------------------------------------- | -------------------------------- |
| esp | `/boot` or `/efi` or `/boot/efi` |
| root | `/` |
| swap | None |
| root-verity | None |
| home | `/home` |
| var | `/var` |
| usr | `/usr` |
| usr-verity | None |
| tmp | `/var/tmp` |
| linux-generic | Any path |
| srv | `/srv` |
| xbootldr | `/boot` |
| unknown(00000000-0000-0000-0000-000000000000) | Any path |
| Partition Type | Valid Mount Paths |
| -------------- | -------------------------------- |
| esp | `/boot` or `/efi` or `/boot/efi` |
| root | `/` |
| swap | None |
| root-verity | None |
| home | `/home` |
| var | `/var` |
| usr | `/usr` |
| usr-verity | None |
| tmp | `/var/tmp` |
| linux-generic | Any path |
| srv | `/srv` |
| xbootldr | `/boot` |
| unknown | Any path |

## Partition Type Matching Hash Partition

Expand Down
Loading