Document platform-specific differences for std::process::exit
.
Fixes https://github.com/rust-lang/rust/issues/35046.
This commit is contained in:
parent
d250169cb5
commit
4d392d355e
1 changed files with 17 additions and 0 deletions
|
@ -828,6 +828,12 @@ impl Child {
|
||||||
/// this function at a known point where there are no more destructors left
|
/// this function at a known point where there are no more destructors left
|
||||||
/// to run.
|
/// to run.
|
||||||
///
|
///
|
||||||
|
/// ## Platform-specific behavior
|
||||||
|
///
|
||||||
|
/// **Unix**: On Unix-like platforms, it is unlikely that all 32 bits of `exit`
|
||||||
|
/// will be visible to a parent process inspecting the exit code. On most
|
||||||
|
/// Unix-like platforms, only the eight least-significant bits are considered.
|
||||||
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
|
@ -835,6 +841,17 @@ impl Child {
|
||||||
///
|
///
|
||||||
/// process::exit(0);
|
/// process::exit(0);
|
||||||
/// ```
|
/// ```
|
||||||
|
///
|
||||||
|
/// Due to [platform-specific behavior], the exit code for this example will be
|
||||||
|
/// `0` on Linux, but `256` on Windows:
|
||||||
|
///
|
||||||
|
/// ```no_run
|
||||||
|
/// use std::process;
|
||||||
|
///
|
||||||
|
/// process::exit(0x0f00);
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// [platform-specific behavior]: #platform-specific-behavior
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
pub fn exit(code: i32) -> ! {
|
pub fn exit(code: i32) -> ! {
|
||||||
::sys_common::cleanup();
|
::sys_common::cleanup();
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue