From 78e06adca7efe01b733fa12af9cffcb5c4a8ad0f Mon Sep 17 00:00:00 2001 From: Steven Fackler Date: Thu, 19 May 2016 22:35:09 -0700 Subject: [PATCH] Mention that the panic hook will always run --- src/libstd/panic.rs | 2 +- src/libstd/panicking.rs | 9 +++++---- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/src/libstd/panic.rs b/src/libstd/panic.rs index a2c6e79fb92..3b170dc9c6d 100644 --- a/src/libstd/panic.rs +++ b/src/libstd/panic.rs @@ -395,7 +395,7 @@ pub fn recover R + UnwindSafe, R>(f: F) -> Result { catch_unwind(f) } -/// Triggers a panic without invoking the panic handler. +/// Triggers a panic without invoking the panic hook. /// /// This is designed to be used in conjunction with `catch_unwind` to, for /// example, carry a panic across a layer of C code. diff --git a/src/libstd/panicking.rs b/src/libstd/panicking.rs index b85d4b330a6..3ad330e79fa 100644 --- a/src/libstd/panicking.rs +++ b/src/libstd/panicking.rs @@ -75,10 +75,11 @@ enum Hook { /// Registers a custom panic hook, replacing any that was previously registered. /// -/// The panic hook is invoked when a thread panics, but before it begins -/// unwinding the stack. The default hook prints a message to standard error -/// and generates a backtrace if requested, but this behavior can be customized -/// with the `set_hook` and `take_hook` functions. +/// The panic hook is invoked when a thread panics, but before the panic runtime +/// is invoked. As such, the hook will run with both the aborting and unwinding +/// runtimes. The default hook prints a message to standard error and generates +/// a backtrace if requested, but this behavior can be customized with the +/// `set_hook` and `take_hook` functions. /// /// The hook is provided with a `PanicInfo` struct which contains information /// about the origin of the panic, including the payload passed to `panic!` and