Auto merge of #33767 - sfackler:panic-hook-docs, r=alexcrichton

Mention that the panic hook will always run

r? @alexcrichton

cc @tomaka
This commit is contained in:
bors 2016-05-21 10:17:40 -07:00
commit 476fe6eefe
2 changed files with 6 additions and 5 deletions

View File

@ -395,7 +395,7 @@ pub fn recover<F: FnOnce() -> R + UnwindSafe, R>(f: F) -> Result<R> {
catch_unwind(f) 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 /// This is designed to be used in conjunction with `catch_unwind` to, for
/// example, carry a panic across a layer of C code. /// example, carry a panic across a layer of C code.

View File

@ -75,10 +75,11 @@ enum Hook {
/// Registers a custom panic hook, replacing any that was previously registered. /// Registers a custom panic hook, replacing any that was previously registered.
/// ///
/// The panic hook is invoked when a thread panics, but before it begins /// The panic hook is invoked when a thread panics, but before the panic runtime
/// unwinding the stack. The default hook prints a message to standard error /// is invoked. As such, the hook will run with both the aborting and unwinding
/// and generates a backtrace if requested, but this behavior can be customized /// runtimes. The default hook prints a message to standard error and generates
/// with the `set_hook` and `take_hook` functions. /// 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 /// The hook is provided with a `PanicInfo` struct which contains information
/// about the origin of the panic, including the payload passed to `panic!` and /// about the origin of the panic, including the payload passed to `panic!` and