Skip to content

Commit b275309

Browse files
authored
[TableGen][Docs] Fix productionlists for assert and dump (llvm#123739)
These were referring to nonexistent grammar tokens instead of `Value`.
1 parent f9af5c1 commit b275309

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

llvm/docs/TableGen/ProgRef.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1316,8 +1316,9 @@ output. It is intended for debugging purpose.
13161316
instantiation point of the containing record.
13171317

13181318
.. productionlist::
1319-
Dump: "dump" `string` ";"
1319+
Dump: "dump" `Value` ";"
13201320

1321+
The :token:`Value` is an arbitrary string expression.
13211322
For example, it can be used in combination with `!repr` to investigate
13221323
the values passed to a multiclass:
13231324

@@ -1364,11 +1365,12 @@ The ``assert`` statement checks a boolean condition to be sure that it is true
13641365
and prints an error message if it is not.
13651366

13661367
.. productionlist::
1367-
Assert: "assert" `condition` "," `message` ";"
1368+
Assert: "assert" `Value` "," `Value` ";"
13681369

1369-
If the boolean condition is true, the statement does nothing. If the
1370-
condition is false, it prints a nonfatal error message. The **message**, which
1371-
can be an arbitrary string expression, is included in the error message as a
1370+
The first :token:`Value` is a boolean condition. If it is true, the
1371+
statement does nothing. If the condition is false, it prints a nonfatal
1372+
error message. The second :token:`Value` is a message, which can be an
1373+
arbitrary string expression. It is included in the error message as a
13721374
note. The exact behavior of the ``assert`` statement depends on its
13731375
placement.
13741376

0 commit comments

Comments
 (0)