Update comment

rust-lang · May 21, 2024 · bcc3d73 · bcc3d73
1 parent ce7670a
commit bcc3d73
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/cargo/util/context/mod.rs b/src/cargo/util/context/mod.rs
@@ -528,6 +528,9 @@ impl GlobalContext {
 
     /// Local overlay configuration.
     ///
+    /// The values in this map are paths pointing to a local registry. Inserted overlays will
+    /// affect any newly created `PackageRegistry`s.
+    ///
     /// See [`crate::sources::overlay::OverlayConfusionAttack`] for why you shouldn't use this.
     pub fn local_overlays(&self) -> RefMut<'_, HashMap<SourceId, PathBuf>> {
         self.local_overlays.borrow_mut()