From 774815ba7faabfc6601f6b2376fedc9443e1dd34 Mon Sep 17 00:00:00 2001 From: Nick Spinale Date: Sun, 6 Oct 2024 22:22:08 -0700 Subject: [PATCH] crates/sel4-panicking/env: Improve rustdoc Signed-off-by: Nick Spinale --- crates/sel4-panicking/env/src/lib.rs | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/crates/sel4-panicking/env/src/lib.rs b/crates/sel4-panicking/env/src/lib.rs index 92f7cf649..9c9c81dee 100644 --- a/crates/sel4-panicking/env/src/lib.rs +++ b/crates/sel4-panicking/env/src/lib.rs @@ -188,7 +188,15 @@ pub fn __abort_macro_helper(message: Option) -> ! { /// Aborts execution with a message. /// -/// This function first invokes an externally defined abort hook which is resolved at link time, and +/// [`abort!`] accepts the same patterns `core::panic!`: +/// +/// ```rust +/// abort!(); +/// abort!("uh oh!"); +/// abort!("uh {} {}!", 123, "oh"); +/// ``` +/// +/// This macro first invokes an externally defined abort hook which is resolved at link time, and /// then calls `core::intrinsics::abort()`. /// /// The following externally defined symbol is used as the abort hook: