[Mlir-commits] [mlir] [MLIR][SCF] Fix LoopPeelOp documentation (NFC) (PR #113179)

Andrzej WarzyƄski llvmlistbot at llvm.org
Tue Oct 29 08:02:02 PDT 2024


================
@@ -156,19 +156,20 @@ def LoopPeelOp : Op<Transform_Dialect, "loop.peel",
      #### Return modes
 
      This operation ignores non-scf::ForOp ops and drops them in the return.
-     The op returns two loops, the peeled loop whose tripcount is divisible by
-     the step and the remainder loop.
-
-     When `peelFront` is true, the first scf::ForOp (the remainder loop)
-     executes all iterations of the target loop but the first one. The second
-     scf::ForOp corresponds to the first iteration of the loop which can be
-     canonicalized away in the following optimizations (the peeled loop).
-
-     When `peelFront` is false, the first result (peeled loop) is "the loop
-     with the highest upper bound that is divisible by the step". The second
-     loopOp (remainder loop) contains the remaining iterations. Note that even
-     though the Payload IR modification may be performed in-place, this
-     operation consumes the operand handle and produces a new one.
+     The op returns two loops, the peeled loop which has trip count divisible
+     by the step, and the remainder loop.
+
+     When `peelFront` is true, the first result (remainder loop) executes all
+     but the first iteration of the target loop. The second result (peeled
+     loop) corresponds to the first iteration of the loop which can be
+     canonicalized away in the following optimizations .
----------------
banach-space wrote:

[nit]
```suggestion
     canonicalized away in the following optimizations.
```

https://github.com/llvm/llvm-project/pull/113179


More information about the Mlir-commits mailing list