From 643005ccaabc4ca5e0c2c8993e246b0817211ce9 Mon Sep 17 00:00:00 2001 From: Longsheng Mou Date: Sun, 25 May 2025 14:24:07 +0800 Subject: [PATCH] [mlir][gpu] Update descriptions format of GPU ops(NFC) --- mlir/include/mlir/Dialect/GPU/IR/GPUOps.td | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td b/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td index 68095b7bf5c59..ea04202082626 100644 --- a/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td +++ b/mlir/include/mlir/Dialect/GPU/IR/GPUOps.td @@ -146,7 +146,7 @@ def GPU_ClusterBlockIdOp : GPU_IndexOp<"cluster_block_id"> { ``` If `upper_bound` is set, then executing (a lowering of) this operation in an - environment where the number of thread blocks per cluster along `dimension` + environment where the number of thread blocks per cluster along `dimension` is greater than `upper_bound` causes undefined behavior. There is an implicit upper bound of `kMaxClusterDim` (currently 8). @@ -1064,7 +1064,7 @@ def GPU_ReturnOp : GPU_Op<"return", [HasParent<"GPUFuncOp">, Pure, Arguments<(ins Variadic:$operands)>, Results<(outs)> { let summary = "Terminator for GPU functions."; let description = [{ - A terminator operation for regions that appear in the body of `gpu.func` + A terminator operation for regions that appear in the body of `gpu.func` functions. The operands to the `gpu.return` are the result values returned by an invocation of the `gpu.func`. }]; @@ -1092,7 +1092,7 @@ def GPU_YieldOp : GPU_Op<"yield", [Pure, ReturnLike, Terminator]>, Arguments<(ins Variadic:$values)> { let summary = "GPU yield operation"; let description = [{ - gpu.yield` is a special terminator operation for blocks inside regions + `gpu.yield` is a special terminator operation for blocks inside regions in gpu ops. It returns values to the immediately enclosing gpu op. Example: @@ -1367,7 +1367,7 @@ def GPU_ShuffleOp : GPU_Op< def GPU_BarrierOp : GPU_Op<"barrier"> { let summary = "Synchronizes all work items of a workgroup."; let description = [{ - The "barrier" op synchronizes all work items of a workgroup. It is used + The `barrier` op synchronizes all work items of a workgroup. It is used to coordinate communication between the work items of the workgroup. ```mlir