From: Matthias Braun <matze@braunis.de>
Date: Tue, 20 Sep 2016 01:14:39 +0000 (+0000)
Subject: Machine{Instr|Operand}: Clarify some isIdenticalTo() subtleties.
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=34c557c6901bed37c8e714aaeab9b0a5e9f4753e;p=llvm

Machine{Instr|Operand}: Clarify some isIdenticalTo() subtleties.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@281956 91177308-0d34-0410-b5e6-96231b3b80d8
---

diff --git a/include/llvm/CodeGen/MachineInstr.h b/include/llvm/CodeGen/MachineInstr.h
index 3da62a33781..c645c20cc17 100644
--- a/include/llvm/CodeGen/MachineInstr.h
+++ b/include/llvm/CodeGen/MachineInstr.h
@@ -721,8 +721,9 @@ public:
     IgnoreVRegDefs  // Ignore virtual register definitions
   };
 
-  /// Return true if this instruction is identical to (same
-  /// opcode and same operands as) the specified instruction.
+  /// Return true if this instruction is identical to \p Other.
+  /// Identical meaning same opcode and all operands reported as
+  /// isIdenticalOp()  (equal except for liveness flags).
   bool isIdenticalTo(const MachineInstr &Other,
                      MICheckType Check = CheckDefs) const;
 
diff --git a/include/llvm/CodeGen/MachineOperand.h b/include/llvm/CodeGen/MachineOperand.h
index 05e6f466184..cf4607957f9 100644
--- a/include/llvm/CodeGen/MachineOperand.h
+++ b/include/llvm/CodeGen/MachineOperand.h
@@ -566,8 +566,8 @@ public:
   // Other methods.
   //===--------------------------------------------------------------------===//
 
-  /// isIdenticalTo - Return true if this operand is identical to the specified
-  /// operand. Note: This method ignores isKill and isDead properties.
+  /// Returns true if this operand is identical to the specified operand except
+  /// for liveness related flags (isKill, isUndef and isDead).
   bool isIdenticalTo(const MachineOperand &Other) const;
 
   /// \brief MachineOperand hash_value overload.