[TableGen] Document sequence with stride
authorJay Foad <jay.foad@amd.com>
Mon, 5 Sep 2022 12:20:11 +0000 (13:20 +0100)
committerJay Foad <jay.foad@amd.com>
Wed, 7 Sep 2022 08:58:22 +0000 (09:58 +0100)
Document (in comments) the optional fourth "stride" argument to the
sequence operator, which was added in svn r157416.

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

llvm/include/llvm/TableGen/SetTheory.h

index 3515642..4cff688 100644 (file)
@@ -38,8 +38,9 @@
 //   the first one. For instance, (decimate S, 2) returns the even elements of
 //   S.
 //
-// - (sequence "Format", From, To) Generate a sequence of defs with printf.
-//   For instance, (sequence "R%u", 0, 3) -> [ R0, R1, R2, R3 ]
+// - (sequence "Format", From, To, [Stride]) Generate a sequence of defs with
+//   printf. For instance, (sequence "R%u", 0, 3) -> [ R0, R1, R2, R3 ] and
+//   (sequence "R%u", 20, 30, 5) -> [ R20, R25, R30 ].
 //
 //===----------------------------------------------------------------------===//