Skip to content

Add context to functions called from build_ukify #1980

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

Draft
jeckersb wants to merge 1 commit into
base: main
Choose a base branch
from
+6 −0
Draft

Add context to functions called from build_ukify #1980

Show file tree
Hide file tree
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
2 changes: 2 additions & 0 deletions crates/lib/src/bootc_composefs/digest.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use cap_std_ext::cap_std::fs::Dir;
use composefs::dumpfile;
use composefs::fsverity::FsVerityHashValue;
use composefs_boot::BootOps as _;
use fn_error_context::context;
use tempfile::TempDir;

use crate::store::ComposefsRepository;
Expand Down Expand Up @@ -49,6 +50,7 @@ pub(crate) fn new_temp_composefs_repo() -> Result<(TempDir, Arc<ComposefsReposit
/// * The path is "/" (cannot operate on active root filesystem)
/// * The filesystem cannot be read
/// * The transform or digest computation fails
#[context("Computing composefs digest")]
pub(crate) fn compute_composefs_digest(
path: &Utf8Path,
write_dumpfile_to: Option<&Utf8Path>,
Expand Down
2 changes: 2 additions & 0 deletions crates/lib/src/bootc_kargs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ use cap_std_ext::cap_std::fs::Dir;
use cap_std_ext::cap_std::fs_utf8::Dir as DirUtf8;
use cap_std_ext::dirext::CapStdExtDirExt;
use cap_std_ext::dirext::CapStdExtDirExtUtf8;
use fn_error_context::context;
use ostree::gio;
use ostree_ext::ostree;
use ostree_ext::ostree::Deployment;
Expand Down Expand Up @@ -107,6 +108,7 @@ pub(crate) fn compute_new_kargs(

/// Load and parse all bootc kargs.d files in the specified root, returning
/// a combined list.
#[context("Getting kargs in root")]
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot Feb 4, 2026

Choose a reason for hiding this comment

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

medium

The context message "Getting kargs in root" is a bit generic. A more descriptive message that details what the function is doing would be more helpful in an error chain. Based on the function's documentation ("Load and parse all bootc kargs.d files in the specified root"), a more specific context would improve debuggability.

Suggested change
#[context("Getting kargs in root")]
#[context("Loading and parsing kargs.d files from root")]

Copy link
Collaborator Author

@jeckersb jeckersb Feb 4, 2026

Choose a reason for hiding this comment

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

Yes but these should be pretty terse since they get strung together into the final error message which can be pretty long by the end of it.

pub(crate) fn get_kargs_in_root(d: &Dir, sys_arch: &str) -> Result<CmdlineOwned> {
// If the directory doesn't exist, that's OK.
let Some(d) = d.open_dir_optional(KARGS_PATH)?.map(DirUtf8::from_cap_std) else {
Expand Down
2 changes: 2 additions & 0 deletions crates/lib/src/kernel.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ use anyhow::Result;
use camino::Utf8PathBuf;
use cap_std_ext::cap_std::fs::Dir;
use cap_std_ext::dirext::CapStdExtDirExt;
use fn_error_context::context;
use serde::Serialize;

use crate::bootc_composefs::boot::EFI_LINUX;
Expand Down Expand Up @@ -63,6 +64,7 @@ impl From<KernelInternal> for Kernel {
/// layout with `/usr/lib/modules/<version>/vmlinuz`.
///
/// Returns `None` if no kernel is found.
#[context("Finding kernel")]
pub(crate) fn find_kernel(root: &Dir) -> Result<Option<KernelInternal>> {
// First, try to find a UKI
if let Some(uki_path) = find_uki_path(root)? {
Expand Down
Loading