about summary refs log tree commit diff
diff options
context:
space:
mode:
authorDylan DPC <99973273+Dylan-DPC@users.noreply.github.com>2022-03-22 19:07:37 +0100
committerGitHub <noreply@github.com>2022-03-22 19:07:37 +0100
commit2aca599325021f352f9bff06fa42daeb3c4bd4f8 (patch)
treed865d2e184c7b207d12c5f553266d4b587f2dfa2
parent5d3dfb446fc696bbeea796ee8e5230ba96ba41b9 (diff)
parent71e34231e089b19c6066efba3744673208ab4ffd (diff)
Rollup merge of #95207 - ZHANGWENTAI:update_termination_doc, r=yaahc
update Termination trait docs

this pr add some statement about intending to provide `Termination` trait only on standard library's runtime.

from #93448

r? `@Lokathor`
-rw-r--r--library/std/src/process.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/library/std/src/process.rs b/library/std/src/process.rs
index d88ab625371..9824cce6c72 100644
--- a/library/std/src/process.rs
+++ b/library/std/src/process.rs
@@ -2030,6 +2030,11 @@ pub fn id() -> u32 {
 ///
 /// The default implementations are returning `libc::EXIT_SUCCESS` to indicate
 /// a successful execution. In case of a failure, `libc::EXIT_FAILURE` is returned.
+///
+/// Because different runtimes have different specifications on the return value
+/// of the `main` function, this trait is likely to be available only on
+/// standard library's runtime for convenience. Other runtimes are not required
+/// to provide similar functionality.
 #[cfg_attr(not(test), lang = "termination")]
 #[unstable(feature = "termination_trait_lib", issue = "43301")]
 #[rustc_on_unimplemented(