Skip to content

Commit

Permalink
crates/sel4-panicking/env: Improve rustdoc
Browse files Browse the repository at this point in the history
Signed-off-by: Nick Spinale <[email protected]>
  • Loading branch information
nspin committed Oct 7, 2024
1 parent 01920ba commit 774815b
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion crates/sel4-panicking/env/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -188,7 +188,15 @@ pub fn __abort_macro_helper(message: Option<fmt::Arguments>) -> ! {

/// 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:
Expand Down

0 comments on commit 774815b

Please sign in to comment.