Rename kargs.rs -> bootc_kargs.rs

It's confusing we have both kargs.rs and kernel.rs where
the latter is also handling kernel arguments.

Clarify what this does.

Signed-off-by: Colin Walters <[email protected]>

Author: cgwalters

crates/lib/src/kargs.rs renamed to crates/lib/src/bootc_kargs.rs

@@ -1,3 +1,4 @@
+//! This module handles the bootc-owned kernel argument lists in `/usr/lib/bootc/kargs.d`.
 use anyhow::{Context, Result};
 use camino::Utf8Path;
 use cap_std_ext::cap_std::fs::Dir;
@@ -15,6 +16,7 @@ use serde::Deserialize;
 use crate::deploy::ImageState;
 use crate::store::Storage;
 
+/// The relative path to the kernel arguments which may be embedded in an image.
 const KARGS_PATH: &str = "usr/lib/bootc/kargs.d";
 
 /// The kargs.d configuration file.

crates/lib/src/deploy.rs

@@ -538,7 +538,7 @@ async fn deploy(
     // is a distinct minor issue, but not super important as right now the install path
     // doesn't use this API).
     let override_kargs = if let Some(deployment) = merge_deployment {
-        Some(crate::kargs::get_kargs(sysroot, &deployment, image)?)
+        Some(crate::bootc_kargs::get_kargs(sysroot, &deployment, image)?)
     } else {
         None
     };

crates/lib/src/install.rs

@@ -817,7 +817,7 @@ async fn install_container(
         .repo()
         .read_commit(pulled_image.ostree_commit.as_str(), gio::Cancellable::NONE)?
         .0;
-    let kargsd = crate::kargs::get_kargs_from_ostree_root(
+    let kargsd = crate::bootc_kargs::get_kargs_from_ostree_root(
         &sysroot.repo(),
         merged_ostree_root.downcast_ref().unwrap(),
         std::env::consts::ARCH,

crates/lib/src/install/completion.rs

@@ -65,7 +65,7 @@ fn reconcile_kargs(sysroot: &ostree::Sysroot, deployment: &ostree::Deployment) -
         .flatten()
         .map(|s| s.as_str())
         .collect::<Vec<_>>();
-    let kargsd = crate::kargs::get_kargs_in_root(deployment_root, std::env::consts::ARCH)?;
+    let kargsd = crate::bootc_kargs::get_kargs_in_root(deployment_root, std::env::consts::ARCH)?;
     let kargsd = kargsd.iter().map(|s| s.as_str()).collect::<Vec<_>>();
 
     current_kargs.append_argv(&install_config_kargs);

crates/lib/src/lib.rs

@@ -4,6 +4,7 @@
 //! to provide a fully "container native" tool for using
 //! bootable container images.
 
+pub(crate) mod bootc_kargs;
 mod boundimage;
 mod cfsctl;
 pub mod cli;
@@ -15,7 +16,6 @@ mod image;
 mod imgstorage;
 pub(crate) mod journal;
 mod k8sapitypes;
-pub(crate) mod kargs;
 mod lints;
 mod lsm;
 pub(crate) mod metadata;

crates/lib/src/lints.rs

@@ -465,7 +465,7 @@ static LINT_KARGS: Lint = Lint::new_fatal(
     check_parse_kargs,
 );
 fn check_parse_kargs(root: &Dir, _config: &LintExecutionConfig) -> LintResult {
-    let args = crate::kargs::get_kargs_in_root(root, ARCH)?;
+    let args = crate::bootc_kargs::get_kargs_in_root(root, ARCH)?;
     tracing::debug!("found kargs: {args:?}");
     lint_ok()
 }