From 22d0440993d6eab6e9faf35f729e2d52ba6d72a6 Mon Sep 17 00:00:00 2001
From: bjorn3 <17426603+bjorn3@users.noreply.github.com>
Date: Thu, 13 Feb 2025 15:38:07 +0000
Subject: [PATCH] Add comments

---
 library/alloc/src/collections/mod.rs | 3 +++
 library/alloc/src/raw_vec/mod.rs     | 3 +++
 library/alloctests/lib.rs            | 3 +++
 3 files changed, 9 insertions(+)

diff --git a/library/alloc/src/collections/mod.rs b/library/alloc/src/collections/mod.rs
index 1414f797e8a4..fac4d1a65abc 100644
--- a/library/alloc/src/collections/mod.rs
+++ b/library/alloc/src/collections/mod.rs
@@ -1,5 +1,8 @@
 //! Collection types.
 
+// Note: This module is also included in the alloctests crate using #[path] to
+// run the tests. See the comment there for an explanation why this is the case.
+
 #![stable(feature = "rust1", since = "1.0.0")]
 
 #[cfg(not(no_global_oom_handling))]
diff --git a/library/alloc/src/raw_vec/mod.rs b/library/alloc/src/raw_vec/mod.rs
index f1f5ffefb9b7..99ebc5c4bfca 100644
--- a/library/alloc/src/raw_vec/mod.rs
+++ b/library/alloc/src/raw_vec/mod.rs
@@ -1,6 +1,9 @@
 #![unstable(feature = "raw_vec_internals", reason = "unstable const warnings", issue = "none")]
 #![cfg_attr(test, allow(dead_code))]
 
+// Note: This module is also included in the alloctests crate using #[path] to
+// run the tests. See the comment there for an explanation why this is the case.
+
 use core::marker::PhantomData;
 use core::mem::{ManuallyDrop, MaybeUninit, SizedTypeProperties};
 use core::ptr::{self, NonNull, Unique};
diff --git a/library/alloctests/lib.rs b/library/alloctests/lib.rs
index 0b5aa2c575d9..6ce8a6d9ca17 100644
--- a/library/alloctests/lib.rs
+++ b/library/alloctests/lib.rs
@@ -67,6 +67,9 @@ extern crate test;
 mod testing;
 use realalloc::*;
 
+// We are directly including collections and raw_vec here as both use non-public
+// methods and fields in tests and as such need to have the types to test in the
+// same crate as the tests themself.
 #[path = "../alloc/src/collections/mod.rs"]
 mod collections;