[MLIR][NFC] Improve doc comment and delete stale comment

Remove duplicate and stale doc comment on affineParallelize. NFC.
llvm · Jul 16, 2021 · edfcfa6 · edfcfa6
1 parent 69a5684
commit edfcfa6
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 9 deletions.
diff --git a/mlir/include/mlir/Dialect/Affine/Utils.h b/mlir/include/mlir/Dialect/Affine/Utils.h
@@ -30,11 +30,12 @@ class Operation;
 
 using ReductionLoopMap = DenseMap<Operation *, SmallVector<LoopReduction, 2>>;
 
-/// Replaces parallel affine.for op with 1-d affine.parallel op.
-/// mlir::isLoopParallel detects the parallel affine.for ops.
-/// Parallelizes the specified reductions. Parallelization will fail in presence
-/// of loop iteration arguments that are not listed in `parallelReductions`.
-/// There is no cost model currently used to drive this parallelization.
+/// Replaces a parallel affine.for op with a 1-d affine.parallel op. `forOp`'s
+/// body is taken by the affine.parallel op and the former is erased.
+/// (mlir::isLoopParallel can be used to detect a parallel affine.for op.) The
+/// reductions specified in `parallelReductions` are also parallelized.
+/// Parallelization will fail in the presence of loop iteration arguments that
+/// are not listed in `parallelReductions`.
 LogicalResult
 affineParallelize(AffineForOp forOp,
                   ArrayRef<LoopReduction> parallelReductions = {});

diff --git a/mlir/lib/Dialect/Affine/Utils/Utils.cpp b/mlir/lib/Dialect/Affine/Utils/Utils.cpp
@@ -129,10 +129,6 @@ static AffineIfOp hoistAffineIfOp(AffineIfOp ifOp, Operation *hoistOverOp) {
   return hoistedIfOp;
 }
 
-/// Replace affine.for with a 1-d affine.parallel and clone the former's body
-/// into the latter while remapping values. Parallelizes the specified
-/// reductions. Parallelization will fail in presence of loop iteration
-/// arguments that are not listed in `parallelReductions`.
 LogicalResult
 mlir::affineParallelize(AffineForOp forOp,
                         ArrayRef<LoopReduction> parallelReductions) {