about summary refs log tree commit diff
diff options
context:
space:
mode:
authorTobias Bucher <tobiasbucher5991@gmail.com>2024-06-11 12:40:03 +0200
committerTobias Bucher <tobiasbucher5991@gmail.com>2024-06-11 17:13:26 +0200
commitbb8eb44511d24b6081c15dbada56f80813d99a4c (patch)
treeb6c1dcbe7ff1994f90de59731de92fb8f36e6555
parent336e6ab3b396e1d1eb9b5a2f0bbc1744f4a68244 (diff)
downloadrust-bb8eb44511d24b6081c15dbada56f80813d99a4c.tar.gz
rust-bb8eb44511d24b6081c15dbada56f80813d99a4c.zip
Unify guarantees about the default allocator
`std::alloc` said that the default allocator is unspecified for all
crrate types except `cdylib` and `staticlib`. Adjust
`std::alloc::System` documentation to say the same.

Fixes #125870.
-rw-r--r--library/std/src/alloc.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/library/std/src/alloc.rs b/library/std/src/alloc.rs
index b98fbbf762f..dc4924cdf58 100644
--- a/library/std/src/alloc.rs
+++ b/library/std/src/alloc.rs
@@ -73,7 +73,9 @@ pub use alloc_crate::alloc::*;
 /// work, such as to serve alignment requests greater than the alignment
 /// provided directly by the backing system allocator.
 ///
-/// This type implements the `GlobalAlloc` trait and Rust programs by default
+/// This type implements the [`GlobalAlloc`] trait. Currently the default
+/// global allocator is unspecified. Libraries, however, like `cdylib`s and
+/// `staticlib`s are guaranteed to use the [`System`] by default and as such
 /// work as if they had this definition:
 ///
 /// ```rust