Skip to content

Commit ea96549

Browse files
raccognicholasbishop
authored andcommitted
Add documentation links for accessing an Output protocol.
Add documentation for #416
1 parent b29d5e7 commit ea96549

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

src/proto/console/text/output.rs

+13
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ use core::fmt::{Debug, Formatter};
77
///
88
/// It implements the fmt::Write trait, so you can use it to print text with
99
/// standard Rust constructs like the `write!()` and `writeln!()` macros.
10+
///
11+
/// # Accessing `Output` protocol
12+
///
13+
/// The standard output and standard error output protocols can be accessed
14+
/// using [`SystemTable::stdout`] and [`SystemTable::stderr`], respectively.
15+
///
16+
/// An `Output` protocol can also be accessed like any other UEFI protocol.
17+
/// See the [`BootServices`] documentation for more details of how to open a
18+
/// protocol.
19+
///
20+
/// [`SystemTable::stdout`]: crate::table::SystemTable::stdout
21+
/// [`SystemTable::stderr`]: crate::table::SystemTable::stderr
22+
/// [`BootServices`]: crate::table::boot::BootServices#accessing-protocols
1023
#[repr(C)]
1124
#[unsafe_guid("387477c2-69c7-11d2-8e39-00a0c969723b")]
1225
#[derive(Protocol)]

0 commit comments

Comments
 (0)