Skip to content

Commit de19e4d

Browse files
ijacksonm-ou-se
authored andcommitted
abort docs: Do not claim that intrinsics::abort is always a debug trap
As per discussion here rust-lang#85377 (review) Signed-off-by: Ian Jackson <[email protected]>
1 parent a8bb7fa commit de19e4d

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

library/core/src/intrinsics.rs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -720,7 +720,9 @@ extern "rust-intrinsic" {
720720
/// [`std::process::abort`](../../std/process/fn.abort.html) is to be preferred if possible,
721721
/// as its behaviour is more user-friendly and more stable.
722722
///
723-
/// The current implementation of `intrinsics::abort` (ab)uses a debug trap. On Unix, the
723+
/// The current implementation of `intrinsics::abort` (ab)uses a debug trap
724+
/// on some popular platforms.
725+
/// On Unix, the
724726
/// process will probably die of a signal like `SIGABRT`, `SIGILL`, `SIGTRAP`, `SIGSEGV` or
725727
/// `SIGBUS`. The precise behaviour is not guaranteed and not stable.
726728
pub fn abort() -> !;

0 commit comments

Comments
 (0)