Merge pull request #1128 from phip1611/remove-uefi-services

Deprecate `uefi-services` and add `uefi::helpers` as replacement

Author: nicholasbishop

Cargo.lock

@@ -23,9 +23,10 @@ This repository provides various crates:
 
 - `uefi-raw`: Raw Rust UEFI bindings for basic structures and functions.
 - `uefi`: High-level wrapper around various low-level UEFI APIs. \
-  Most probably, you want to use this crate.
-- `uefi-services`: Optional Rust convenience with a global allocator and a
-  `log`-based logger implementation.
+  Offers various optional features for typical Rust convenience, such as a
+  Logger and an Allocator. (_This is what you are usually looking for!_)
+- `uefi-macros`: Helper macros. Used by `uefi`.
+
 
 You can use the abstractions for example to:
 
@@ -44,6 +45,8 @@ our Rust library.
 
 ## User Documentation
 
+<!-- KEEP IN SYNC WITH uefi/README -->
+
 For a quick start, please check out [the UEFI application template](template).
 
 The [uefi-rs book] contains a tutorial, how-tos, and overviews of some important
@@ -53,7 +56,6 @@ UEFI concepts. Reference documentation for the various crates can be found on
 - [docs.rs/uefi](https://docs.rs/uefi)
 - [docs.rs/uefi-macros](https://docs.rs/uefi-macros)
 - [docs.rs/uefi-raw](https://docs.rs/uefi-raw)
-- [docs.rs/uefi-services](https://docs.rs/uefi-services)
 
 For additional information, refer to the [UEFI specification][spec].
 

README.md

@@ -6,4 +6,3 @@ publish = false
 
 [dependencies]
 uefi = { version = "0.27.0", features = ["alloc"] }
-uefi-services = "0.24.0"

template/Cargo.toml

@@ -5,7 +5,7 @@ use uefi::prelude::*;
 
 #[entry]
 fn main(_handle: Handle, mut system_table: SystemTable<Boot>) -> Status {
-    uefi_services::init(&mut system_table).unwrap();
+    uefi::helpers::init(&mut system_table).unwrap();
 
     Status::SUCCESS
 }

template/src/main.rs

@@ -1,8 +1,8 @@
 # uefi-services - [Unreleased]
 
 ## Changed
-- The implicit `qemu-exit` crate feature has been removed. (Note that this is
-  different from the `qemu` crate feature, which is unchanged.)
+- `uefi-services` is deprecated and should be removed. All functionality was
+  moved to `uefi::helpers::init()`
 
 # uefi-services - 0.23.0 (2023-11-12)
 

uefi-services/CHANGELOG.md

@@ -2,7 +2,7 @@
 name = "uefi-services"
 version = "0.24.0"
 readme = "README.md"
-description = "Higher-level utilities for the `uefi` crate."
+description = "Deprecated. Please migrate to `uefi::helpers`."
 
 authors.workspace = true
 categories.workspace = true
@@ -14,13 +14,10 @@ rust-version.workspace = true
 
 [dependencies]
 uefi = { version = "0.27.0", features = ["global_allocator"] }
-log.workspace = true
-cfg-if = "1.0.0"
-qemu-exit = { version = "3.0.1", optional = true }
 
 [features]
 default = ["panic_handler", "logger"]
 # Enable QEMU-specific functionality
-qemu = ["dep:qemu-exit"]
-panic_handler = []
+qemu = ["uefi/qemu"]
+panic_handler = [ "uefi/panic_handler" ]
 logger = ["uefi/logger"]

uefi-services/Cargo.toml

@@ -1,17 +1,3 @@
 # uefi-services
 
-[![Crates.io](https://img.shields.io/crates/v/uefi-services)](https://crates.io/crates/uefi-services)
-[![Docs.rs](https://docs.rs/uefi-macros/badge.svg)](https://docs.rs/uefi-services)
-
-This crate enables you some convenience features on top of the
-[`uefi`](https://crates.io/crates/uefi) crate. It includes a panic handler, a logger, and
-a global allocator.
-
-`uefi-services` is part of the `uefi-rs` project. Please refer to
-<https://github.com/rust-osdev/uefi-rs/> for comprehensive documentation.
-
-## Optional features
-
-This crate's features are described in [`src/lib.rs`].
-  
-[`src/lib.rs`]: src/lib.rs
+WARNING: `uefi-services` is deprecated. Functionality was moved to `uefi::helpers::init`.

uefi-services/README.md

@@ -0,0 +1,3 @@
+fn main() {
+    println!("cargo:warning=`uefi-services` is deprecated. Functionality was moved to `uefi::helpers::init`.");
+}