Improved wording in comments and logs

Author: ohadravid

compiler/rustc_mir_transform/src/copy_prop.rs

@@ -52,9 +52,10 @@ impl<'tcx> crate::MirPass<'tcx> for CopyProp {
         let fully_moved = fully_moved_locals(&ssa, body);
         debug!(?fully_moved);
 
-        // We can determine if we can keep the head's storage statements (which enables better optimizations).
-        // For every local's usage location, we'll to remove it's storage statements only if the head is maybe-uninitialized,
-        // or if the local is borrowed (since we cannot easily identify when it is used).
+        // When emitting storage statements, we want to retain the head locals' storage statements,
+        // as this enables better optimizations. For each local use location, we mark the head for storage removal
+        // only if the head might be uninitialized at that point, or if the local is borrowed
+        // (since we cannot easily determine when it's used).
         let storage_to_remove = if tcx.sess.emit_lifetime_markers() {
             storage_to_remove.clear();
 
@@ -75,7 +76,7 @@ impl<'tcx> crate::MirPass<'tcx> for CopyProp {
 
             storage_checker.storage_to_remove
         } else {
-            // Conservatively remove all storage statements for the head locals.
+            // Remove the storage statements of all the head locals.
             storage_to_remove
         };
 
@@ -233,7 +234,7 @@ impl<'a, 'tcx> Visitor<'tcx> for StorageChecker<'a, 'tcx> {
                 ?context,
                 ?local,
                 ?head,
-                "found a head at a location in which it is maybe uninit, marking head for storage statement removal"
+                "local's head is maybe uninit at this location, marking head for storage statement removal"
             );
             self.storage_to_remove.insert(head);
         }

compiler/rustc_mir_transform/src/gvn.rs

@@ -141,8 +141,9 @@ impl<'tcx> crate::MirPass<'tcx> for GVN {
             state.visit_basic_block_data(bb, data);
         }
 
-        // If we emit storage annotations, use `MaybeStorageDead` to check which reused locals
-        // require storage removal (making them alive for the duration of the function).
+        // When emitting storage statements, we want to retain the reused locals' storage statements,
+        // as this enables better optimizations. For each local use location, we mark it for storage removal
+        // only if it might be uninitialized at that point.
         let storage_to_remove = if tcx.sess.emit_lifetime_markers() {
             let maybe_uninit = MaybeUninitializedLocals::new()
                 .iterate_to_fixpoint(tcx, body, Some("mir_opt::gvn"))
@@ -160,7 +161,7 @@ impl<'tcx> crate::MirPass<'tcx> for GVN {
 
             storage_checker.storage_to_remove
         } else {
-            // Conservatively remove all storage statements for reused locals.
+            // Remove the storage statements of all the reused locals.
             state.reused_locals.clone()
         };
 
@@ -1907,7 +1908,11 @@ impl<'a, 'tcx> Visitor<'tcx> for StorageChecker<'a, 'tcx> {
         self.maybe_uninit.seek_before_primary_effect(location);
 
         if self.maybe_uninit.get().contains(local) {
-            debug!(?location, ?local, "local is maybe uninit in this location, removing storage");
+            debug!(
+                ?location,
+                ?local,
+                "local is reused and is maybe uninit at this location, marking it for storage statement removal"
+            );
             self.storage_to_remove.insert(local);
         }
     }