From 28ef0d1085120d72741bc52fc2dacfe18ebe8a2e Mon Sep 17 00:00:00 2001 From: Pirh Date: Mon, 2 Oct 2017 19:59:50 +0100 Subject: Document that process::abort will not call the panic hook --- src/libstd/process.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'src/libstd') diff --git a/src/libstd/process.rs b/src/libstd/process.rs index fa9ec4b3185..dbb58991215 100644 --- a/src/libstd/process.rs +++ b/src/libstd/process.rs @@ -1129,7 +1129,8 @@ pub fn exit(code: i32) -> ! { /// This is in contrast to the default behaviour of [`panic!`] which unwinds /// the current thread's stack and calls all destructors. /// When `panic="abort"` is set, either as an argument to `rustc` or in a -/// crate's Cargo.toml, [`panic!`] and `abort` are equivalent. +/// crate's Cargo.toml, [`panic!`] and `abort` are similar. However, +/// [`panic!`] will still call the [panic hook] while `abort` will not. /// /// If a clean shutdown is needed it is recommended to only call /// this function at a known point where there are no more destructors left @@ -1171,6 +1172,7 @@ pub fn exit(code: i32) -> ! { /// ``` /// /// [`panic!`]: ../../std/macro.panic.html +/// [panic hook]: ../../std/panic/fn.set_hook.html #[stable(feature = "process_abort", since = "1.17.0")] pub fn abort() -> ! { unsafe { ::sys::abort_internal() }; -- cgit 1.4.1-3-g733a5