From bc69bd10872162caf0d9a42ac71ad9f60b6533ef Mon Sep 17 00:00:00 2001 From: Nicholas Bishop Date: Tue, 27 Aug 2024 15:31:28 -0400 Subject: [PATCH] uefi: Drop references to SystemTable from docstrings --- uefi/src/lib.rs | 10 +++------- uefi/src/mem/memory_map/mod.rs | 2 +- uefi/src/proto/console/text/output.rs | 6 +++--- 3 files changed, 7 insertions(+), 11 deletions(-) diff --git a/uefi/src/lib.rs b/uefi/src/lib.rs index 84e99bc1a..7a7ce8a65 100644 --- a/uefi/src/lib.rs +++ b/uefi/src/lib.rs @@ -100,12 +100,9 @@ //! //! ## Tables //! -//! The [`SystemTable`] provides access to almost everything in UEFI. It comes -//! in two flavors: -//! - `SystemTable`: for boot-time applications such as bootloaders, -//! provides access to both boot and runtime services. -//! - `SystemTable`: for operating systems after boot services have -//! been exited. +//! Most UEFI functionality comes from the system, boot, and runtime +//! tables. These can be accessed via the [`system`], [`boot`], and [`runtime`] +//! modules. //! //! ## Protocols //! @@ -204,7 +201,6 @@ //! [UEFI]: https://uefi.org/ //! [Zulip]: https://rust-osdev.zulipchat.com //! [`GlobalAlloc`]: alloc::alloc::GlobalAlloc -//! [`SystemTable`]: table::SystemTable //! [`ctr16!`]: crate::cstr16 //! [`entry-macro`]: uefi_macros::entry //! [`r-efi`]: https://crates.io/crates/r-efi diff --git a/uefi/src/mem/memory_map/mod.rs b/uefi/src/mem/memory_map/mod.rs index 232c54e4e..46cd82903 100644 --- a/uefi/src/mem/memory_map/mod.rs +++ b/uefi/src/mem/memory_map/mod.rs @@ -28,7 +28,7 @@ //! [`MemoryMapMeta`], //! - re-exports [`MemoryDescriptor`], [`MemoryType`], and [`MemoryAttribute`]. //! -//! [`boot::exit_boot_services`]: crate::table::SystemTable::exit_boot_services +//! [`boot::exit_boot_services`]: crate::boot::exit_boot_services //! [`boot::memory_map`]: crate::boot::memory_map mod api; diff --git a/uefi/src/proto/console/text/output.rs b/uefi/src/proto/console/text/output.rs index a4c5c4cfe..5dd599d27 100644 --- a/uefi/src/proto/console/text/output.rs +++ b/uefi/src/proto/console/text/output.rs @@ -11,14 +11,14 @@ use uefi_raw::protocol::console::{SimpleTextOutputMode, SimpleTextOutputProtocol /// # Accessing `Output` protocol /// /// The standard output and standard error output protocols can be accessed -/// using [`SystemTable::stdout`] and [`SystemTable::stderr`], respectively. +/// using [`system::stdout`] and [`system::stderr`], respectively. /// /// An `Output` protocol can also be accessed like any other UEFI protocol. /// See the [`boot`] documentation for more details of how to open a /// protocol. /// -/// [`SystemTable::stdout`]: crate::table::SystemTable::stdout -/// [`SystemTable::stderr`]: crate::table::SystemTable::stderr +/// [`system::stdout`]: crate::system::with_stdout +/// [`system::stderr`]: crate::system::with_stderr /// [`boot`]: crate::boot#accessing-protocols #[derive(Debug)] #[repr(transparent)]