From bd947632b5da12ccb28a446a62898862f8f415ed Mon Sep 17 00:00:00 2001 From: Ben Kimock Date: Wed, 26 Oct 2022 07:14:20 -0700 Subject: [PATCH] Update library/core/src/ptr/mod.rs Co-authored-by: Ralf Jung --- library/core/src/ptr/mod.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/library/core/src/ptr/mod.rs b/library/core/src/ptr/mod.rs index 2c19c27681f..3fd61755903 100644 --- a/library/core/src/ptr/mod.rs +++ b/library/core/src/ptr/mod.rs @@ -591,6 +591,7 @@ pub const fn invalid_mut(addr: usize) -> *mut T { /// the program has undefined behavior. In particular, the aliasing rules still apply: pointers /// and references that have been invalidated due to aliasing accesses cannot be used any more, /// even if they have been exposed! +/// /// Note that there is no algorithm that decides which provenance will be used. You can think of this /// as "guessing" the right provenance, and the guess will be "maximally in your favor", in the sense /// that if there is any way to avoid undefined behavior (while upholding all aliasing requirements),