[PATCH] D90804: [TableGen] Clean up documentation toctrees; clarify two paragraphs.

[Paul C. Anagnostopoulos via Phabricator via llvm-commits]

Paul-C-Anagnostopoulos created this revision.
Paul-C-Anagnostopoulos added reviewers: lattner, nhaehnle.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.
Paul-C-Anagnostopoulos requested review of this revision.

This patch cleans up the TableGen documentation toctrees.

It also clarifies two paragraphs in the Backend Guide and adds a cross-reference.

I will auto-LGTM this in 24 hours.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D90804

Files:
  llvm/docs/TableGen/BackGuide.rst
  llvm/docs/TableGen/ProgRef.rst


Index: llvm/docs/TableGen/ProgRef.rst
===================================================================
--- llvm/docs/TableGen/ProgRef.rst
+++ llvm/docs/TableGen/ProgRef.rst
@@ -7,12 +7,6 @@
 .. contents::
    :local:
 
-.. toctree::
-   :hidden:
-
-   BackEnds
-   BackGuide
-
 Introduction
 ============
 
Index: llvm/docs/TableGen/BackGuide.rst
===================================================================
--- llvm/docs/TableGen/BackGuide.rst
+++ llvm/docs/TableGen/BackGuide.rst
@@ -27,8 +27,8 @@
 
 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 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 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
 


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D90804.302984.patch
Type: text/x-patch
Size: 1688 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20201104/2afafd33/attachment.bin>