document Box and box_free connection

2021-11-09 07:13:53 -05:00 · 2021-11-09 07:13:53 -05:00 · db4e60b29f
commit db4e60b29f
parent 214cd1f228
1 changed files with 3 additions and 0 deletions
--- a/library/alloc/src/boxed.rs
+++ b/library/alloc/src/boxed.rs
@ -169,6 +169,9 @@
 #[lang = "owned_box"]
 #[fundamental]
 #[stable(feature = "rust1", since = "1.0.0")]
+// The declaration of the `Box` struct must be kept in sync with the
+// `alloc::alloc::box_free` function or ICEs will happen. See the comment
+// on `box_free` for more details.
 pub struct Box<
    T: ?Sized,
    #[unstable(feature = "allocator_api", issue = "32838")] A: Allocator = Global,