mathieu/os-rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rollup merge of #115247 - the8472:life-before-main, r=dtolnay

Browse source 
Document std limitations before/after main

Solves #110708
This commit is contained in:
Matthias Krüger 2023-09-16 23:20:39 +02:00 • committed by GitHub
commit cf9ce96a5b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
library/std/src/lib.rs
View file

@ -152,6 +152,31 @@
//! contains further primitive shared memory types, including [`atomic`] and //! contains further primitive shared memory types, including [`atomic`] and
//! [`mpsc`], which contains the channel types for message passing. //! [`mpsc`], which contains the channel types for message passing.
//! //!
//! # Use before and after `main()`
//!
//! Many parts of the standard library are expected to work before and after `main()`;
//! but this is not guaranteed or ensured by tests. It is recommended that you write your own tests
//! and run them on each platform you wish to support.
//! This means that use of `std` before/after main, especially of features that interact with the
//! OS or global state, is exempted from stability and portability guarantees and instead only
//! provided on a best-effort basis. Nevertheless bug reports are appreciated.
//!
//! On the other hand `core` and `alloc` are most likely to work in such environments with
//! the caveat that any hookable behavior such as panics, oom handling or allocators will also
//! depend on the compatibility of the hooks.
//!
//! Some features may also behave differently outside main, e.g. stdio could become unbuffered,
//! some panics might turn into aborts, backtraces might not get symbolicated or similar.
//!
//! Non-exhaustive list of known limitations:
//!
//! - after-main use of thread-locals, which also affects additional features:
//! - [`thread::current()`]
//! - [`thread::scope()`]
//! - [`sync::mpsc`]
//! - before-main stdio file descriptors are not guaranteed to be open on unix platforms
//!
//!
//! [I/O]: io //! [I/O]: io
//! [`MIN`]: i32::MIN //! [`MIN`]: i32::MIN
//! [`MAX`]: i32::MAX //! [`MAX`]: i32::MAX
@ -187,7 +212,6 @@
//! [rust-discord]: https://discord.gg/rust-lang //! [rust-discord]: https://discord.gg/rust-lang
//! [array]: prim@array //! [array]: prim@array
//! [slice]: prim@slice //! [slice]: prim@slice
// To run std tests without x.py without ending up with two copies of std, Miri needs to be // To run std tests without x.py without ending up with two copies of std, Miri needs to be
// able to "empty" this crate. See <https://github.com/rust-lang/miri-test-libstd/issues/4>. // able to "empty" this crate. See <https://github.com/rust-lang/miri-test-libstd/issues/4>.
// rustc itself never sets the feature, so this line has no effect there. // rustc itself never sets the feature, so this line has no effect there.