Add doc-comment note on Edit that stack-to-stack moves are never generated.

2021-06-19 11:34:05 -07:00
parent b36a563d69
commit 36975b8b6f
1 changed files with 2 additions and 1 deletions
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -892,7 +892,8 @@ impl ProgPoint {
 #[derive(Clone, Debug)]
 pub enum Edit {
    /// Move one allocation to another. Each allocation may be a
-    /// register or a stack slot (spillslot).
+    /// register or a stack slot (spillslot). However, stack-to-stack
+    /// moves will never be generated.
    ///
    /// `to_vreg`, if defined, is useful as metadata: it indicates
    /// that the moved value is a def of a new vreg.