[Mlir-commits] [mlir] 86778e8 - [MLIR][NFC] Rework some comments.

[Rahul Joshi]

Author: Rahul Joshi
Date: 2021-07-26T17:09:04-07:00
New Revision: 86778e8b3036d95e684edef469495110f1c2f121

URL: https://github.com/llvm/llvm-project/commit/86778e8b3036d95e684edef469495110f1c2f121
DIFF: https://github.com/llvm/llvm-project/commit/86778e8b3036d95e684edef469495110f1c2f121.diff

LOG: [MLIR][NFC] Rework some comments.

Differential Revision: https://reviews.llvm.org/D106834

Added: 
    

Modified: 
    mlir/include/mlir/Analysis/AliasAnalysis/LocalAliasAnalysis.h
    mlir/include/mlir/Analysis/DataFlowAnalysis.h
    mlir/include/mlir/Interfaces/ControlFlowInterfaces.h
    mlir/include/mlir/Interfaces/ControlFlowInterfaces.td

Removed: 
    


################################################################################
diff  --git a/mlir/include/mlir/Analysis/AliasAnalysis/LocalAliasAnalysis.h b/mlir/include/mlir/Analysis/AliasAnalysis/LocalAliasAnalysis.h
index afed185e6c29c..d8bf933d81f8a 100644
--- a/mlir/include/mlir/Analysis/AliasAnalysis/LocalAliasAnalysis.h
+++ b/mlir/include/mlir/Analysis/AliasAnalysis/LocalAliasAnalysis.h
@@ -18,9 +18,9 @@
 #include "mlir/Analysis/AliasAnalysis.h"
 
 namespace mlir {
-/// This class implements a location form of aliasing that tries to identify the
-/// underlying values addressed by each value and performs a few basic checks to
-/// see if they alias.
+/// This class implements a local form of alias analysis that tries to identify
+/// the underlying values addressed by each value and performs a few basic
+/// checks to see if they alias.
 class LocalAliasAnalysis {
 public:
   /// Given two values, return their aliasing behavior.

diff  --git a/mlir/include/mlir/Analysis/DataFlowAnalysis.h b/mlir/include/mlir/Analysis/DataFlowAnalysis.h
index 8248019df7d66..7566c4d21b826 100644
--- a/mlir/include/mlir/Analysis/DataFlowAnalysis.h
+++ b/mlir/include/mlir/Analysis/DataFlowAnalysis.h
@@ -6,7 +6,7 @@
 //
 //===----------------------------------------------------------------------===//
 //
-// This files several utilities and algorithms that perform abstract dataflow
+// This file has several utilities and algorithms that perform abstract dataflow
 // analysis over the IR. These allow for users to hook into various analysis
 // propagation algorithms without needing to reinvent the traversal over the
 // 
diff erent types of control structures present within MLIR, such as regions,

diff  --git a/mlir/include/mlir/Interfaces/ControlFlowInterfaces.h b/mlir/include/mlir/Interfaces/ControlFlowInterfaces.h
index 761a378947441..fd4c560422377 100644
--- a/mlir/include/mlir/Interfaces/ControlFlowInterfaces.h
+++ b/mlir/include/mlir/Interfaces/ControlFlowInterfaces.h
@@ -52,9 +52,10 @@ LogicalResult verifyTypesAlongControlFlowEdges(Operation *op);
 /// This class represents a successor of a region. A region successor can either
 /// be another region, or the parent operation. If the successor is a region,
 /// this class represents the destination region, as well as a set of arguments
-/// from that region that will be populated by values from the current region.
+/// from that region that will be populated when control flows into the region.
 /// If the successor is the parent operation, this class represents an optional
-/// set of results that will be populated by values from the current region.
+/// set of results that will be populated when control returns to the parent
+/// operation.
 ///
 /// This interface assumes that the values from the current region that are used
 /// to populate the successor inputs are the operands of the return-like

diff  --git a/mlir/include/mlir/Interfaces/ControlFlowInterfaces.td b/mlir/include/mlir/Interfaces/ControlFlowInterfaces.td
index 38396a195238c..bb635e77c4a12 100644
--- a/mlir/include/mlir/Interfaces/ControlFlowInterfaces.td
+++ b/mlir/include/mlir/Interfaces/ControlFlowInterfaces.td
@@ -119,7 +119,7 @@ def RegionBranchOpInterface : OpInterface<"RegionBranchOpInterface"> {
         `index` is None, `operands` is a set of optional attributes that
         either correspond to a constant value for each operand of this
         operation, or null if that operand is not a constant. If `index` is
-        valid, `operands` corresponds to the exit values of the region at
+        valid, `operands` corresponds to the entry values of the region at
         `index`. Only a region, i.e. a valid `index`, may use the parent
         operation as a successor. This method allows for describing which
         regions may be executed when entering an operation, and which regions