From 7a38b010e0a298e2c1c76501ec9b164ce7db0743 Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Tue, 30 Jul 2024 09:43:03 +0200 Subject: [PATCH 1/3] doc: drop Trivia section We are already referring to the UEFI spec which is sufficient. --- README.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/README.md b/README.md index cb44e01b5..4b5a687e8 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,6 @@ This crate makes it easy to develop Rust software that leverages **safe**, ## Description -[UEFI] started as the successor firmware to the BIOS in x86 space and developed -to a universal firmware specification for various platforms, such as ARM. It -provides an early boot environment with a variety of [specified][spec] -ready-to-use "high-level" functionality, such as accessing disks or the network. -EFI images, the files that can be loaded by an UEFI environment, can leverage -these abstractions to extend the functionality in form of additional drivers, -OS-specific bootloaders, or different kind of low-level applications. - Our mission is to provide **safe** and **performant** wrappers for UEFI interfaces, and allow developers to write idiomatic Rust code. From 876a2ccd74b33a70f4b1973a84168715789b483d Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Tue, 30 Jul 2024 11:07:22 +0200 Subject: [PATCH 2/3] doc: move Supported Architectures to lib.rs --- README.md | 4 ---- uefi/src/lib.rs | 6 ++++++ 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 4b5a687e8..3730ef1cc 100644 --- a/README.md +++ b/README.md @@ -30,10 +30,6 @@ You can use the abstractions for example to: - create OS-specific loaders and leverage UEFI boot service - access UEFI runtime services from an OS -All crates are compatible with all platforms that both the Rust compiler and -UEFI support, such as `i686`, `x86_64`, and `aarch64`). Please note that we -can't test all possible hardware/firmware/platform combinations. - [UEFI]: https://en.wikipedia.org/wiki/Unified_Extensible_Firmware_Interface ![UEFI App running in QEMU](https://imgur.com/SFPSVuO.png) diff --git a/uefi/src/lib.rs b/uefi/src/lib.rs index b69550f9e..5c99fc71b 100644 --- a/uefi/src/lib.rs +++ b/uefi/src/lib.rs @@ -16,6 +16,12 @@ //! epochs. However, the `uefi` crate unfolds its true potential when //! interacting with UEFI boot services. //! +//! ## Supported Architectures +//! +//! `uefi` is compatible with all platforms that both the Rust compiler and +//! UEFI support, such as `i686`, `x86_64`, and `aarch64`. Please note that we +//! can't test all possible hardware/firmware/platform combinations in CI. +//! //! # Crate organisation //! //! The top-level module contains some of the most used types and macros, From 048ffa1d9ede9590242ca877a7674176b620d93d Mon Sep 17 00:00:00 2001 From: Philipp Schuster Date: Tue, 30 Jul 2024 10:59:19 +0200 Subject: [PATCH 3/3] doc: streamline sections Contributing, MSRV, and License Copy MSRV, License, and Contributing sections to lib.rs and streamline it with the README equivalents. We should also include these information in lib.rs, as it is the main entry point into everything relevant about the library. At least, it should from now on. The big benefit is that the documentation on `docs.rs` then covers everything relevant. --- README.md | 12 ++++++++---- uefi/src/lib.rs | 29 ++++++++++++++++++++++++++--- 2 files changed, 34 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3730ef1cc..f352b7632 100644 --- a/README.md +++ b/README.md @@ -116,11 +116,14 @@ most of the library's functionality. Check out the testing project's [`README.md`](uefi-test-runner/README.md) for prerequisites for running the tests. -## Contributing +## Discuss and Contribute -We welcome issues and pull requests! For instructions on how to set up a -development environment and how to add new protocols, check out -[CONTRIBUTING.md](CONTRIBUTING.md). +For general discussions, feel free to join us in our [Zulip] and ask +your questions there. + +Further, you can submit bugs and also ask questions in our [issue tracker]. +Contributions in the form of a PR are also highly welcome. Check our +[contributing guide](./CONTRIBUTING.md) for details. ## License @@ -131,3 +134,4 @@ 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 +[Zulip]: https://rust-osdev.zulipchat.com diff --git a/uefi/src/lib.rs b/uefi/src/lib.rs index 5c99fc71b..22e13860e 100644 --- a/uefi/src/lib.rs +++ b/uefi/src/lib.rs @@ -7,9 +7,6 @@ //! important UEFI concepts. For more details of UEFI, see the latest [UEFI //! Specification][spec]. //! -//! Feel free to file bug reports and questions in our [issue tracker], and [PR -//! contributions][contributing] are also welcome! -//! //! # Interaction with uefi services //! //! With this crate you can write code for the pre- and post-exit boot services @@ -80,8 +77,34 @@ //! only unfold their potential when you invoke `uefi::helpers::init` as soon //! as possible in your application. //! +//! # Discuss and Contribute +//! +//! For general discussions, feel free to join us in our [Zulip] and ask +//! your questions there. +//! +//! Further, you can submit bugs and also ask questions in our [issue tracker]. +//! Contributions in the form of a PR are also highly welcome. Check our +//! [contributing guide][contributing] for details. +//! +//! # MSRV +//! +//! +//! The minimum supported Rust version is currently 1.70. +//! Our policy is to support at least the past two stable releases. +//! +//! # License +//! +//! +//! 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]. +//! +//! [LICENSE]: https://github.com/rust-osdev/uefi-rs/blob/main/uefi/LICENSE //! [Rust UEFI Book]: https://rust-osdev.github.io/uefi-rs/HEAD/ //! [UEFI]: https://uefi.org/ +//! [Zulip]: https://rust-osdev.zulipchat.com //! [`BootServices`]: table::boot::BootServices //! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc //! [`SystemTable`]: table::SystemTable