about summary refs log tree commit diff
diff options
context:
space:
mode:
authorMatthias Krüger <matthias.krueger@famsik.de>2024-06-30 10:39:46 +0200
committerGitHub <noreply@github.com>2024-06-30 10:39:46 +0200
commitb2d46036c504d324c7a0483dd39b48f8ceb8c8fd (patch)
tree76840dfbf26db54b0037b81d2830434090f4928c
parent716752ebe6974b5c6ab9b34b894e075f3e4a4b1e (diff)
parent28ba5e4124659107bd0ed08ba5c480d0e71c3aa1 (diff)
downloadrust-b2d46036c504d324c7a0483dd39b48f8ceb8c8fd.tar.gz
rust-b2d46036c504d324c7a0483dd39b48f8ceb8c8fd.zip
Rollup merge of #126705 - safinaskar:panic, r=Mark-Simulacrum
Updated docs on `#[panic_handler]` in `library/core/src/lib.rs`
-rw-r--r--library/core/src/lib.rs7
1 files changed, 2 insertions, 5 deletions
diff --git a/library/core/src/lib.rs b/library/core/src/lib.rs
index cfadfb0233e..128f1c81827 100644
--- a/library/core/src/lib.rs
+++ b/library/core/src/lib.rs
@@ -34,12 +34,9 @@
 //!   Rust user code is to call the functions provided by this library instead (such as
 //!   `ptr::copy`).
 //!
-//! * `rust_begin_panic` - This function takes four arguments, a
-//!   `fmt::Arguments`, a `&'static str`, and two `u32`'s. These four arguments
-//!   dictate the panic message, the file at which panic was invoked, and the
-//!   line and column inside the file. It is up to consumers of this core
+//! * Panic handler - This function takes one argument, a `&panic::PanicInfo`. It is up to consumers of this core
 //!   library to define this panic function; it is only required to never
-//!   return. This requires a `lang` attribute named `panic_impl`.
+//!   return. You should mark your implementation using `#[panic_handler]`.
 //!
 //! * `rust_eh_personality` - is used by the failure mechanisms of the
 //!    compiler. This is often mapped to GCC's personality function, but crates