about summary refs log tree commit diff
path: root/library/std/src/sys/unix/stack_overflow.rs
diff options
context:
space:
mode:
authorIan Jackson <ijackson@chiark.greenend.org.uk>2021-05-13 18:59:41 +0100
committerMara Bos <m-ou.se@m-ou.se>2021-07-05 12:43:00 +0200
commita8bb7fa76b3d9d288ad12e9a86be96ee0e6abadf (patch)
tree2524e324d86490efb12131d00e55d7fd02db73fd /library/std/src/sys/unix/stack_overflow.rs
parentc54895bea6a96defe4c9a7041013efe7505c3ff2 (diff)
downloadrust-a8bb7fa76b3d9d288ad12e9a86be96ee0e6abadf.tar.gz
rust-a8bb7fa76b3d9d288ad12e9a86be96ee0e6abadf.zip
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 (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>
Diffstat (limited to 'library/std/src/sys/unix/stack_overflow.rs')
0 files changed, 0 insertions, 0 deletions