[llvm] [TableGen][Docs] Fix productionlists for assert and dump (PR #123739)

Jay Foad via llvm-commits llvm-commits at lists.llvm.org
Tue Jan 21 04:05:34 PST 2025


https://github.com/jayfoad created https://github.com/llvm/llvm-project/pull/123739

These were referring to nonexistent grammar tokens instead of `Value`.


>From 17c9704ca38905a0a90561232069fdd259cfea60 Mon Sep 17 00:00:00 2001
From: Jay Foad <jay.foad at amd.com>
Date: Tue, 21 Jan 2025 12:01:43 +0000
Subject: [PATCH] [TableGen][Docs] Fix productionlists for assert and dump

These were referring to nonexistent grammar tokens instead of `Value`.
---
 llvm/docs/TableGen/ProgRef.rst | 11 ++++++-----
 1 file changed, 6 insertions(+), 5 deletions(-)

diff --git a/llvm/docs/TableGen/ProgRef.rst b/llvm/docs/TableGen/ProgRef.rst
index cfe61382658ec4..150033500a3f35 100644
--- a/llvm/docs/TableGen/ProgRef.rst
+++ b/llvm/docs/TableGen/ProgRef.rst
@@ -1302,7 +1302,7 @@ output. It is intended for debugging purpose.
   instantiation point of the containing record.
 
 .. productionlist::
-   Dump: "dump"  `string` ";"
+   Dump: "dump" `Value` ";"
 
 For example, it can be used in combination with `!repr` to investigate
 the values passed to a multiclass:
@@ -1350,11 +1350,12 @@ The ``assert`` statement checks a boolean condition to be sure that it is true
 and prints an error message if it is not.
 
 .. productionlist::
-   Assert: "assert" `condition` "," `message` ";"
+   Assert: "assert" `Value` "," `Value` ";"
 
-If the boolean condition is true, the statement does nothing. If the
-condition is false, it prints a nonfatal error message. The **message**, which
-can be an arbitrary string expression, is included in the error message as a
+The first :token:`Value` is a boolean condition. If it is true, the
+statement does nothing. If the condition is false, it prints a nonfatal
+error message. The second :token:`Value` is a message, which can be an
+arbitrary string expression. It is included in the error message as a
 note. The exact behavior of the ``assert`` statement depends on its
 placement.
 



More information about the llvm-commits mailing list