[llvm] 6f288b1 - [TableGen] Clean up documentation toctrees; clarify two paragraphs.
Paul C. Anagnostopoulos via llvm-commits
llvm-commits at lists.llvm.org
Thu Nov 5 13:19:48 PST 2020
Author: Paul C. Anagnostopoulos
Date: 2020-11-05T16:19:18-05:00
New Revision: 6f288b11dba7f7ef01bdc4a3202e908bdc0fb067
URL: https://github.com/llvm/llvm-project/commit/6f288b11dba7f7ef01bdc4a3202e908bdc0fb067
DIFF: https://github.com/llvm/llvm-project/commit/6f288b11dba7f7ef01bdc4a3202e908bdc0fb067.diff
LOG: [TableGen] Clean up documentation toctrees; clarify two paragraphs.
Differential Revision: https://reviews.llvm.org/D90804
Added:
Modified:
llvm/docs/TableGen/BackGuide.rst
llvm/docs/TableGen/ProgRef.rst
Removed:
################################################################################
diff --git a/llvm/docs/TableGen/BackGuide.rst b/llvm/docs/TableGen/BackGuide.rst
index 0463c96b5794..b9b9cf83bae9 100644
--- a/llvm/docs/TableGen/BackGuide.rst
+++ b/llvm/docs/TableGen/BackGuide.rst
@@ -27,8 +27,8 @@ header file (``record.h``) and/or the Doxygen documentation.
This document assumes that you have read the :doc:`TableGen Programmer's
Reference <./ProgRef>`, which provides a detailed reference for coding
-TableGen source files. This document and the data structure comments will be
-improved over time.
+TableGen source files. For a description of the existing backends, see
+:doc:`TableGen BackEnds <./BackEnds>`.
Data Structures
===============
@@ -738,7 +738,9 @@ The ``PrintRecords`` Backend
The TableGen command option ``--print-records`` invokes a simple backend
that prints all the classes and records defined in the source files. This is
-the default backend option. The output looks like this:
+the default backend option. The format of the output is guaranteed to be
+constant over time, so that the output can be compared in tests. The output
+looks like this:
.. code-block:: text
@@ -776,7 +778,8 @@ The ``PrintDetailedRecords`` Backend
The TableGen command option ``--print-detailed-records`` invokes a backend
that prints all the global variables, classes, and records defined in the
-source files. The output looks like this.
+source files. The format of the output is *not* guaranteed to be constant
+over time. The output looks like this.
.. code-block:: text
diff --git a/llvm/docs/TableGen/ProgRef.rst b/llvm/docs/TableGen/ProgRef.rst
index 4b8365139715..26c0f0793be8 100644
--- a/llvm/docs/TableGen/ProgRef.rst
+++ b/llvm/docs/TableGen/ProgRef.rst
@@ -7,12 +7,6 @@ TableGen Programmer's Reference
.. contents::
:local:
-.. toctree::
- :hidden:
-
- BackEnds
- BackGuide
-
Introduction
============
More information about the llvm-commits
mailing list