diff options
| author | Ralf Jung <post@ralfj.de> | 2023-08-15 13:39:46 +0200 |
|---|---|---|
| committer | Ralf Jung <post@ralfj.de> | 2023-08-15 13:39:46 +0200 |
| commit | fb4ac63415fbf6635a59a39c078d766ba8fc4b5c (patch) | |
| tree | c5de6a8f975bfb4135d4ce0372ebf7b59c8b7be5 | |
| parent | dfee1ba4c466c32d1817631e675ed458a18e088c (diff) | |
| download | rust-fb4ac63415fbf6635a59a39c078d766ba8fc4b5c.tar.gz rust-fb4ac63415fbf6635a59a39c078d766ba8fc4b5c.zip | |
clarify that these assumtpions are for us, not all Rust code
| -rw-r--r-- | library/core/src/lib.rs | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/library/core/src/lib.rs b/library/core/src/lib.rs index d8531c70a8a..c2602fa19eb 100644 --- a/library/core/src/lib.rs +++ b/library/core/src/lib.rs @@ -29,6 +29,10 @@ //! (Note that these are [standard assumptions](https://reviews.llvm.org/D86993) among compilers.) //! These functions are often provided by the system libc, but can also be provided by the //! [compiler-builtins crate](https://crates.io/crates/compiler_builtins). +//! Note that the library does not guarantee that it will always make these assumptions, so Rust +//! user code directly calling the C functions should follow the C specification! The advice for +//! Rust user code is to call the functions provided by this library instead (such as +//! `ptr::copy`). //! //! * `rust_begin_panic` - This function takes four arguments, a //! `fmt::Arguments`, a `&'static str`, and two `u32`'s. These four arguments |
