[PATCH] D100382: [TableGen] [docs] Correct a reference in the TableGen Overview

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

Paul-C-Anagnostopoulos created this revision.
Paul-C-Anagnostopoulos added a reviewer: aaronpuchert.
Herald added a subscriber: arphaman.
Paul-C-Anagnostopoulos requested review of this revision.
Herald added a project: LLVM.
Herald added a subscriber: llvm-commits.

This little patch corrects a reference in the TableGen Overview document. I also reworked a couple of sentences in the introduction.

I think I can approve this myself in a day or two?


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D100382

Files:
  llvm/docs/TableGen/index.rst


Index: llvm/docs/TableGen/index.rst
===================================================================
--- llvm/docs/TableGen/index.rst
+++ llvm/docs/TableGen/index.rst
@@ -25,17 +25,18 @@
 The TableGen front end parses a file, instantiates the declarations, and
 hands the result off to a domain-specific `backend`_ for processing.  See
 the :doc:`TableGen Programmer's Reference <./ProgRef>` for an in-depth
-description of TableGen. See :doc:`xxx-tblgen - Target Description to C++
-Code <../CommandGuide/tblgen>` for details on the various
-``xxx-tblgen`` commands that invoke TableGen.
+description of TableGen. See :doc:`tblgen - Description to C++ Code
+<../CommandGuide/tblgen>` for details on the ``*-tblgen`` commands
+that run the various flavors of TableGen.
 
 The current major users of TableGen are :doc:`The LLVM Target-Independent
 Code Generator <../CodeGenerator>` and the `Clang diagnostics and attributes
 <https://clang.llvm.org/docs/UsersManual.html#controlling-errors-and-warnings>`_.
 
-Note that if you work on TableGen much, and use emacs or vim, that you can find
-an emacs "TableGen mode" and a vim language file in the ``llvm/utils/emacs`` and
-``llvm/utils/vim`` directories of your LLVM distribution, respectively.
+Note that if you work with TableGen frequently and use emacs or vim,
+you can find an emacs "TableGen mode" and a vim language file in the
+``llvm/utils/emacs`` and ``llvm/utils/vim`` directories of your LLVM
+distribution, respectively.
 
 .. _intro:
 
@@ -263,7 +264,7 @@
 =================
 
 TableGen files have no real meaning without a backend. The default operation
-when running ``xxx-tblgen`` is to print the information in a textual format, but
+when running ``*-tblgen`` is to print the information in a textual format, but
 that's only useful for debugging the TableGen files themselves. The power
 in TableGen is, however, to interpret the source files into an internal 
 representation that can be generated into anything you want.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D100382.337134.patch
Type: text/x-patch
Size: 1995 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20210413/13b585b1/attachment.bin>