Skip to content

Commit

Permalink
abort docs: Do not claim that intrinsics::abort is always a debug trap
Browse files Browse the repository at this point in the history
As per discussion here
 rust-lang#85377 (review)

Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>
  • Loading branch information
ijackson authored and m-ou-se committed Jul 5, 2021
1 parent a8bb7fa commit de19e4d
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion library/core/src/intrinsics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -720,7 +720,9 @@ extern "rust-intrinsic" {
/// [`std::process::abort`](../../std/process/fn.abort.html) is to be preferred if possible,
/// as its behaviour is more user-friendly and more stable.
///
/// The current implementation of `intrinsics::abort` (ab)uses a debug trap. On Unix, the
/// The current implementation of `intrinsics::abort` (ab)uses a debug trap
/// on some popular platforms.
/// On Unix, the
/// process will probably die of a signal like `SIGABRT`, `SIGILL`, `SIGTRAP`, `SIGSEGV` or
/// `SIGBUS`. The precise behaviour is not guaranteed and not stable.
pub fn abort() -> !;
Expand Down

0 comments on commit de19e4d

Please sign in to comment.