From a1eebad4a06a9fc8e4dd59a93c960ea3681ce792 Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Sun, 28 Jul 2024 15:31:32 +0200 Subject: [PATCH 1/2] uefi: remove documentation about already removed feature --- uefi/Cargo.toml | 1 + uefi/src/lib.rs | 4 +--- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/uefi/Cargo.toml b/uefi/Cargo.toml index 2fe9e257b..adeb43acb 100644 --- a/uefi/Cargo.toml +++ b/uefi/Cargo.toml @@ -13,6 +13,7 @@ repository.workspace = true rust-version.workspace = true [features] +# KEEP this feature list in sync with doc in lib.rs! default = [ "log-debugcon" ] alloc = [] diff --git a/uefi/src/lib.rs b/uefi/src/lib.rs index 4d2825b8b..865683cb4 100644 --- a/uefi/src/lib.rs +++ b/uefi/src/lib.rs @@ -42,7 +42,7 @@ //! protocol, and see the [`proto`] module for protocol implementations. New //! protocols can be defined with the [`unsafe_protocol`] macro. //! -//! ## Optional crate features +//! ## Optional Cargo crate features //! //! - `alloc`: Enable functionality requiring the [`alloc`] crate from //! the Rust standard library. For example, methods that return a @@ -59,8 +59,6 @@ //! that prints output to the UEFI console. No buffering is done; this //! is not a high-performance logger. //! - `panic_handler`: Add a default panic handler that logs to `stdout`. -//! - `panic-on-logger-errors` (enabled by default): Panic if a text -//! output error occurs in the logger. //! - `unstable`: Enable functionality that depends on [unstable //! features] in the nightly compiler. //! As example, in conjunction with the `alloc`-feature, this gate allows From 1ad49ebbb5303d7376df838afb1717575118276c Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Tue, 30 Jul 2024 09:36:11 +0200 Subject: [PATCH 2/2] doc: unified catchy new Crate introduction The main idea here is to: - tell that `uefi` is not only for EFI images but also apps that interact with UEFI functionality, such as parsing a memory map from a pre-defined chunk of memory. - streamline the doc (cargo.toml, README, lib.rs) --- README.md | 7 +++++++ uefi/Cargo.toml | 5 ++++- uefi/README.md | 11 +++++++++-- uefi/src/lib.rs | 3 +++ 4 files changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 768964871..cb44e01b5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # uefi-rs +Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI]. + +This crate makes it easy to develop Rust software that leverages **safe**, +**convenient**, and **performant** abstractions for [UEFI] functionality. + [![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi) [![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi) ![License](https://img.shields.io/github/license/rust-osdev/uefi-rs) @@ -136,3 +141,5 @@ This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced. The full text of the license is available in the [license file](LICENSE). + +[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface diff --git a/uefi/Cargo.toml b/uefi/Cargo.toml index adeb43acb..d41b6d4b8 100644 --- a/uefi/Cargo.toml +++ b/uefi/Cargo.toml @@ -2,7 +2,10 @@ name = "uefi" version = "0.29.0" readme = "README.md" -description = "Safe and easy-to-use wrapper for building UEFI apps." +description = """ +This crate makes it easy to develop Rust software that leverages safe, +convenient, and performant abstractions for UEFI functionality. +""" authors.workspace = true categories.workspace = true diff --git a/uefi/README.md b/uefi/README.md index 625a39363..37ad9b40a 100644 --- a/uefi/README.md +++ b/uefi/README.md @@ -1,4 +1,9 @@ -# uefi-rs +# `uefi` + +Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI]. + +This crate makes it easy to develop Rust software that leverages **safe**, +**convenient**, and **performant** abstractions for [UEFI] functionality. [![Crates.io](https://img.shields.io/crates/v/uefi)](https://crates.io/crates/uefi) [![Docs.rs](https://docs.rs/uefi/badge.svg)](https://docs.rs/uefi) @@ -6,7 +11,6 @@ ![Build status](https://github.com/rust-osdev/uefi-rs/workflows/Rust/badge.svg) ![Stars](https://img.shields.io/github/stars/rust-osdev/uefi-rs) - For an introduction to the `uefi-rs` project and documentation, please refer to our main [README]. @@ -47,3 +51,6 @@ The code in this repository is licensed under the Mozilla Public License 2. This license allows you to use the crate in proprietary programs, but any modifications to the files must be open-sourced. The full text of the license is available in the [license file](LICENSE). + + +[UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface diff --git a/uefi/src/lib.rs b/uefi/src/lib.rs index 865683cb4..b69550f9e 100644 --- a/uefi/src/lib.rs +++ b/uefi/src/lib.rs @@ -1,5 +1,8 @@ //! Rusty wrapper for the [Unified Extensible Firmware Interface][UEFI]. //! +//! This crate makes it easy to develop Rust software that leverages **safe**, +//! **convenient**, and **performant** abstractions for [UEFI] functionality. +//! //! See the [Rust UEFI Book] for a tutorial, how-tos, and overviews of some //! important UEFI concepts. For more details of UEFI, see the latest [UEFI //! Specification][spec].