summary refs log tree commit diff
path: root/library/std/src/sys/unsupported
diff options
context:
space:
mode:
authorChristiaan Dirkx <christiaan@dirkx.email>2021-04-18 07:19:39 +0200
committerChristiaan Dirkx <christiaan@dirkx.email>2021-04-22 18:00:18 +0200
commite1b1081d2ff80f49129da2002ce3f5efa6186825 (patch)
treedcc0b789e324332e48071fe55131a9d62e6ec03f /library/std/src/sys/unsupported
parent8aeea227daf4a78761c41bb32321e8b2e505d27e (diff)
downloadrust-e1b1081d2ff80f49129da2002ce3f5efa6186825.tar.gz
rust-e1b1081d2ff80f49129da2002ce3f5efa6186825.zip
Document that `init` and `cleanup` are not guaranteed to run
Diffstat (limited to 'library/std/src/sys/unsupported')
-rw-r--r--library/std/src/sys/unsupported/common.rs2
1 files changed, 2 insertions, 0 deletions
diff --git a/library/std/src/sys/unsupported/common.rs b/library/std/src/sys/unsupported/common.rs
index c60c2a9b8e8..6e72a7c632e 100644
--- a/library/std/src/sys/unsupported/common.rs
+++ b/library/std/src/sys/unsupported/common.rs
@@ -11,9 +11,11 @@ pub use crate::sys_common::os_str_bytes as os_str;
 use crate::os::raw::c_char;
 
 // SAFETY: must be called only once during runtime initialization.
+// NOTE: this is not guaranteed to run, for example when Rust code is called externally.
 pub unsafe fn init(_argc: isize, _argv: *const *const u8) {}
 
 // SAFETY: must be called only once during runtime cleanup.
+// NOTE: this is not guaranteed to run, for example when the program aborts.
 pub unsafe fn cleanup() {}
 
 pub fn unsupported<T>() -> std_io::Result<T> {