about summary refs log tree commit diff
path: root/library/std/src/sys/unix/stack_overflow.rs
diff options
context:
space:
mode:
authorYuki Okushi <jtitor@2k36.org>2021-07-06 02:33:13 +0900
committerGitHub <noreply@github.com>2021-07-06 02:33:13 +0900
commitadd24d2f4fe5f4194bf81d6be6e539491e776918 (patch)
treea04e210a35be1e422b5eb0dbb642042da12d031b /library/std/src/sys/unix/stack_overflow.rs
parent1fcd9abbb1f80a0a467d8e54b573a7ba207925c7 (diff)
parent08d912fdcc4b9c8af3c00db78804f85abfadbd7a (diff)
downloadrust-add24d2f4fe5f4194bf81d6be6e539491e776918.tar.gz
rust-add24d2f4fe5f4194bf81d6be6e539491e776918.zip
Rollup merge of #85377 - ijackson:abort-docs, r=m-ou-se
aborts: Clarify documentation and comments

In the docs for intrinsics::abort():

 * Strengthen the recommendation by to use process::abort instead.
 * Document the fact that it sometimes (ab)uses an LLVM debug trap and what the likely consequences are.
 * State that the precise behaviour is unstable.

In the docs for process::abort():

 * Promise that we have the same behaviour as C `abort()`.
 * Document the likely consequences, including, specifically, the consequences on Unix.

In the internal comment for unix::abort_internal:

 * Refer to the public docs for the public API functions.
 * Correct and expand the description of libc::abort.  Specifically:
 * Do not claim that abort() unregisters signal handlers.  It doesn't; it honours the SIGABRT handler.
 * Discuss, extensively, the issue with abort() flushing stdio buffers.
 * Describe the glibc behaviour in some detail.

Co-authored-by: Mark Wooding <mdw@distorted.org.uk>
Signed-off-by: Ian Jackson <ijackson@chiark.greenend.org.uk>

Fixes #40230
Diffstat (limited to 'library/std/src/sys/unix/stack_overflow.rs')
0 files changed, 0 insertions, 0 deletions