diff options
| author | bors <bors@rust-lang.org> | 2016-05-21 10:17:40 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2016-05-21 10:17:40 -0700 |
| commit | 476fe6eefe17db91ff7a60aab34aa67a0a750a18 (patch) | |
| tree | 3cfe44a3c989a280a5fae3f3c08654cdeb41b792 /src/libstd | |
| parent | da41920919ef4164c91541b8da501e36e9544c0f (diff) | |
| parent | 78e06adca7efe01b733fa12af9cffcb5c4a8ad0f (diff) | |
| download | rust-476fe6eefe17db91ff7a60aab34aa67a0a750a18.tar.gz rust-476fe6eefe17db91ff7a60aab34aa67a0a750a18.zip | |
Auto merge of #33767 - sfackler:panic-hook-docs, r=alexcrichton
Mention that the panic hook will always run r? @alexcrichton cc @tomaka
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/panic.rs | 2 | ||||
| -rw-r--r-- | 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<F: FnOnce() -> R + UnwindSafe, R>(f: F) -> Result<R> { 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 @@ static FIRST_PANIC: AtomicBool = AtomicBool::new(true); /// 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 |
