refactor: change "efiboot" tool name to "efivarcli"

iTrooz · Jan 16, 2024 · cf1fbd7 · cf1fbd7
1 parent b364785
commit cf1fbd7
Show file tree

Hide file tree

Showing 41 changed files with 88 additions and 74 deletions.
diff --git a/.releaserc.json b/.releaserc.json
@@ -15,7 +15,7 @@
                 "assets": [
                     "CHANGELOG.md",
                     "Cargo.lock",
-                    "efiboot/Cargo.toml",
+                    "efivarcli/Cargo.toml",
                     "efivar/Cargo.toml",
                     "efivar/src/lib.rs"
                 ],

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [workspace]
 members = [
-    "efiboot",
+    "efivarcli",
     "efivar"
 ]
 

diff --git a/Makefile.toml b/Makefile.toml
@@ -27,7 +27,7 @@ if is_windows
     suffix = set ".exe"
 end
 
-target_binary_name = set efiboot
+target_binary_name = set efivarcli
 target_binary = set "target/release/${target_binary_name}${suffix}"
 
 mkdir ${output_dir}

diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@ This repository contains the source code for:
 * [![crates.io](https://img.shields.io/crates/v/efivar.svg)](https://crates.io/crates/efivar) [efivar](efivar) - A Rust crate to read and write EFI variables
 * [![crates.io](https://img.shields.io/crates/v/efiboot.svg)](https://crates.io/crates/efiboot) [efiboot](efiboot) - A command-line tool to manage the UEFI boot manager
 
-The efiboot tool supports both Windows and Linux:
+The efivarcli tool supports both Windows and Linux:
 
 * Windows: administrative rights are required to both *read* and *write* variables.
 * Linux: the efivar filesystem should be mounted at /sys/firmware/efi/efivars on all major

diff --git a/efivar/README.md b/efivar/README.md
@@ -1,7 +1,7 @@
 # efivar
 
 efivar is a Rust crate for manipulating EFI variables using the OS interface.
-This crate is mainly used by [efiboot](../efiboot) to implement its
+This crate is mainly used by [efivarcli](../efivarcli) to implement its
 functionality.
 
 ## Author

diff --git a/efivar/src/lib.rs b/efivar/src/lib.rs
@@ -1,5 +1,5 @@
 //! efivar is a crate for manipulating EFI variables using the OS interface. This crate is mainly
-//! used by `efiboot` to implement its functionality.
+//! used by `efivarcli` to implement its functionality.
 //!
 //! On Linux, it is assumed that efivarfs is mounted and available at /sys/firmware/efi/efivars,
 //! which should be the default nowadays on all major distros.

diff --git a/efiboot/.gitignore → efivarcli/.gitignore b/efiboot/.gitignore → efivarcli/.gitignore
diff --git a/efiboot/Cargo.toml → efivarcli/Cargo.toml b/efiboot/Cargo.toml → efivarcli/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "efiboot"
+name = "efivarcli"
 version = "1.4.0"
 authors = ["Vincent Tavernier <[email protected]>", "iTrooz <[email protected]>"]
 license = "MIT"

diff --git a/efiboot/README.md → efivarcli/README.md b/efiboot/README.md → efivarcli/README.md
@@ -1,8 +1,10 @@
-# efiboot
+# efivarcli
 
-efiboot is a Rust crate that provides the `efiboot` utility, a command-line tool
+efivarcli is a Rust crate that provides the `efivarcli` utility, a command-line tool
 to manage EFI variables related to UEFI boot manager operation.
 
 ## Author
 
+iTrooz
+
 Vincent Tavernier <[email protected]>
diff --git a/efiboot/src/cli/boot/add.rs → efivarcli/src/cli/boot/add.rs b/efiboot/src/cli/boot/add.rs → efivarcli/src/cli/boot/add.rs
diff --git a/efiboot/src/cli/boot/delete.rs → efivarcli/src/cli/boot/delete.rs b/efiboot/src/cli/boot/delete.rs → efivarcli/src/cli/boot/delete.rs
diff --git a/efiboot/src/cli/boot/enable_disable.rs → efivarcli/src/cli/boot/enable_disable.rs b/efiboot/src/cli/boot/enable_disable.rs → efivarcli/src/cli/boot/enable_disable.rs
diff --git a/efiboot/src/cli/boot/get_entries.rs → efivarcli/src/cli/boot/get_entries.rs b/efiboot/src/cli/boot/get_entries.rs → efivarcli/src/cli/boot/get_entries.rs
diff --git a/efiboot/src/cli/boot/mod.rs → efivarcli/src/cli/boot/mod.rs b/efiboot/src/cli/boot/mod.rs → efivarcli/src/cli/boot/mod.rs
diff --git a/efiboot/src/cli/boot/next.rs → efivarcli/src/cli/boot/next.rs b/efiboot/src/cli/boot/next.rs → efivarcli/src/cli/boot/next.rs
@@ -64,7 +64,7 @@ pub fn run(manager: &mut dyn VarManager, cmd: BootNextCommand) -> ExitCode {
                 .attributes
                 .contains(BootEntryAttributes::LOAD_OPTION_ACTIVE)
             {
-                eprintln!("Warning: boot entry is not active, and may not boot. Enable it with `efiboot boot enable {id:04X}`");
+                eprintln!("Warning: boot entry is not active, and may not boot. Enable it with `efivarcli boot enable {id:04X}`");
             }
 
             manager

diff --git a/efiboot/src/cli/boot/order/add.rs → efivarcli/src/cli/boot/order/add.rs b/efiboot/src/cli/boot/order/add.rs → efivarcli/src/cli/boot/order/add.rs
diff --git a/efiboot/src/cli/boot/order/get.rs → efivarcli/src/cli/boot/order/get.rs b/efiboot/src/cli/boot/order/get.rs → efivarcli/src/cli/boot/order/get.rs
diff --git a/efiboot/src/cli/boot/order/mod.rs → efivarcli/src/cli/boot/order/mod.rs b/efiboot/src/cli/boot/order/mod.rs → efivarcli/src/cli/boot/order/mod.rs
@@ -15,7 +15,7 @@ mod tests;
 
 #[derive(Parser)]
 pub enum OrderCommand {
-    /// Get current boot order IDs. See `efiboot boot get-entries` to get boot entries information
+    /// Get current boot order IDs. See `efivarcli boot get-entries` to get boot entries information
     Get,
     /// Adds an id to the boot order
     Add {

diff --git a/efiboot/src/cli/boot/order/remove.rs → efivarcli/src/cli/boot/order/remove.rs b/efiboot/src/cli/boot/order/remove.rs → efivarcli/src/cli/boot/order/remove.rs
@@ -14,7 +14,7 @@ pub fn run(manager: &mut dyn VarManager, id: u16, force: bool) -> ExitCode {
 
     if manager.read(&Variable::new(&id.boot_var_name())).is_ok() && !force {
         eprintln!("Warning: A variable with the name {} exists. Deleting its id from the boot order won't delete it.\n\
-            Use `efiboot boot del {id:04X}` instead.\n\
+            Use `efivarcli boot del {id:04X}` instead.\n\
             Pass argument --force to skip this warning", id.boot_var_name());
         return ExitCode::FAILURE;
     }

diff --git a/efiboot/src/cli/boot/order/set.rs → efivarcli/src/cli/boot/order/set.rs b/efiboot/src/cli/boot/order/set.rs → efivarcli/src/cli/boot/order/set.rs
diff --git a/efiboot/src/cli/boot/order/tests.rs → efivarcli/src/cli/boot/order/tests.rs b/efiboot/src/cli/boot/order/tests.rs → efivarcli/src/cli/boot/order/tests.rs
@@ -28,7 +28,7 @@ fn get_order() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "order", "get"]),
+            Command::parse_from(["efivarcli", "boot", "order", "get"]),
             manager,
         )
     );
@@ -41,7 +41,16 @@ fn set_order() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "order", "set", "0001", "2", "1000", "500"]),
+            Command::parse_from([
+                "efivarcli",
+                "boot",
+                "order",
+                "set",
+                "0001",
+                "2",
+                "1000",
+                "500"
+            ]),
             manager,
         )
     );
@@ -66,15 +75,15 @@ fn add_to_order() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "order", "add", "1", "--position", "0"]),
+            Command::parse_from(["efivarcli", "boot", "order", "add", "1", "--position", "0"]),
             manager,
         )
     );
 
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "order", "add", "500"]),
+            Command::parse_from(["efivarcli", "boot", "order", "add", "500"]),
             manager,
         )
     );
@@ -99,7 +108,7 @@ fn remove_from_order() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "order", "remove", "1000"]),
+            Command::parse_from(["efivarcli", "boot", "order", "remove", "1000"]),
             manager,
         )
     );
@@ -124,7 +133,7 @@ fn remove_inexistent_from_order() {
     assert_eq!(
         ExitCode::FAILURE,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "order", "remove", "2000"]),
+            Command::parse_from(["efivarcli", "boot", "order", "remove", "2000"]),
             manager,
         )
     );

diff --git a/efiboot/src/cli/boot/partition/linux.rs → efivarcli/src/cli/boot/partition/linux.rs b/efiboot/src/cli/boot/partition/linux.rs → efivarcli/src/cli/boot/partition/linux.rs
diff --git a/efiboot/src/cli/boot/partition/mod.rs → efivarcli/src/cli/boot/partition/mod.rs b/efiboot/src/cli/boot/partition/mod.rs → efivarcli/src/cli/boot/partition/mod.rs
diff --git a/efiboot/src/cli/boot/partition/windows.rs → efivarcli/src/cli/boot/partition/windows.rs b/efiboot/src/cli/boot/partition/windows.rs → efivarcli/src/cli/boot/partition/windows.rs
diff --git a/efiboot/src/cli/boot/tests/add.rs → efivarcli/src/cli/boot/tests/add.rs b/efiboot/src/cli/boot/tests/add.rs → efivarcli/src/cli/boot/tests/add.rs
@@ -14,19 +14,19 @@ use crate::{
 
 #[test]
 fn add() {
-    //! Test that the basic `efiboot boot add` subcommand works.
+    //! Test that the basic `efivarcli boot add` subcommand works.
     //! Note: we are using the current partition, not specifying one
 
     let manager = &mut MemoryStore::new();
 
     let setup_entry = standard_setup(manager, 0x0001);
 
-    // execute `efiboot boot add`
+    // execute `efivarcli boot add`
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
             Command::parse_from([
-                "efiboot",
+                "efivarcli",
                 "boot",
                 "add",
                 "--file",
@@ -63,18 +63,18 @@ fn add() {
 
 #[test]
 fn add_set_id() {
-    //! Use `efiboot boot add` with a given entry ID.
+    //! Use `efivarcli boot add` with a given entry ID.
 
     let manager = &mut MemoryStore::new();
 
     let setup_entry = standard_setup(manager, 0x0001);
 
-    // execute `efiboot boot add`
+    // execute `efivarcli boot add`
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
             Command::parse_from([
-                "efiboot",
+                "efivarcli",
                 "boot",
                 "add",
                 "--file",
@@ -116,18 +116,18 @@ fn add_set_id() {
 
 #[test]
 fn add_verify_file_path_fix() {
-    //! Use `efiboot boot add` with a given entry ID.
+    //! Use `efivarcli boot add` with a given entry ID.
 
     let manager = &mut MemoryStore::new();
 
     let setup_entry = standard_setup(manager, 0x0001);
 
-    // execute `efiboot boot add`
+    // execute `efivarcli boot add`
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
             Command::parse_from([
-                "efiboot",
+                "efivarcli",
                 "boot",
                 "add",
                 "--file",
@@ -181,12 +181,12 @@ fn add_on_existing() {
         .unwrap()
         .to_owned();
 
-    // execute `efiboot boot add`
+    // execute `efivarcli boot add`
     assert_eq!(
         ExitCode::FAILURE,
         crate::run(
             Command::parse_from([
-                "efiboot",
+                "efivarcli",
                 "boot",
                 "add",
                 "--file",

diff --git a/efiboot/src/cli/boot/tests/delete.rs → efivarcli/src/cli/boot/tests/delete.rs b/efiboot/src/cli/boot/tests/delete.rs → efivarcli/src/cli/boot/tests/delete.rs
@@ -15,7 +15,7 @@ fn delete() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "delete", "1"]),
+            Command::parse_from(["efivarcli", "boot", "delete", "1"]),
             manager,
         )
     );

diff --git a/efiboot/src/cli/boot/tests/enable_disable.rs → ...rcli/src/cli/boot/tests/enable_disable.rs b/efiboot/src/cli/boot/tests/enable_disable.rs → ...rcli/src/cli/boot/tests/enable_disable.rs
@@ -19,7 +19,7 @@ fn enable() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "enable", "0001",]),
+            Command::parse_from(["efivarcli", "boot", "enable", "0001",]),
             manager,
         )
     );
@@ -40,7 +40,7 @@ fn enable_enabled() {
     assert_eq!(
         ExitCode::FAILURE,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "enable", "0001",]),
+            Command::parse_from(["efivarcli", "boot", "enable", "0001",]),
             manager,
         )
     );
@@ -61,7 +61,7 @@ fn disable() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "disable", "0001",]),
+            Command::parse_from(["efivarcli", "boot", "disable", "0001",]),
             manager,
         )
     );
@@ -82,7 +82,7 @@ fn disable_disabled() {
     assert_eq!(
         ExitCode::FAILURE,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "disable", "0001",]),
+            Command::parse_from(["efivarcli", "boot", "disable", "0001",]),
             manager,
         )
     );

diff --git a/efiboot/src/cli/boot/tests/get_entries.rs → efivarcli/src/cli/boot/tests/get_entries.rs b/efiboot/src/cli/boot/tests/get_entries.rs → efivarcli/src/cli/boot/tests/get_entries.rs
@@ -18,7 +18,7 @@ fn get_entries() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "get-entries"]),
+            Command::parse_from(["efivarcli", "boot", "get-entries"]),
             manager,
         )
     );
@@ -33,7 +33,7 @@ fn get_entries_verbose() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "get-entries", "-v"]),
+            Command::parse_from(["efivarcli", "boot", "get-entries", "-v"]),
             manager,
         )
     );
@@ -49,7 +49,7 @@ fn get_entries_not_in_bootorder() {
     assert_eq!(
         ExitCode::SUCCESS,
         crate::run(
-            Command::parse_from(["efiboot", "boot", "get-entries"]),
+            Command::parse_from(["efivarcli", "boot", "get-entries"]),
             manager,
         )
     );

diff --git a/efiboot/src/cli/boot/tests/mod.rs → efivarcli/src/cli/boot/tests/mod.rs b/efiboot/src/cli/boot/tests/mod.rs → efivarcli/src/cli/boot/tests/mod.rs