This is an archive of the discontinued LLVM Phabricator instance.

Differential D100382

[TableGen] [docs] Correct a reference in the TableGen Overview
ClosedPublic

Authored by Paul-C-Anagnostopoulos on Apr 13 2021, 6:40 AM.

Details

Reviewers
aaronpuchert
Commits
rG9345f9fa5d64: [TableGen] [docs] Correct a reference in the TableGen Overview document
Summary

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?

Diff Detail

Event Timeline

Paul-C-Anagnostopoulos created this revision.Apr 13 2021, 6:40 AM
Herald added a subscriber: arphaman. · View Herald TranscriptApr 13 2021, 6:40 AM
Paul-C-Anagnostopoulos requested review of this revision.Apr 13 2021, 6:40 AM
Herald added a project: Restricted Project. · View Herald TranscriptApr 13 2021, 6:40 AM
Herald added a subscriber: llvm-commits. · View Herald Transcript
Harbormaster completed remote builds in B98474: Diff 337134.Apr 13 2021, 7:25 AM
aaronpuchert accepted this revision.Apr 13 2021, 11:24 AM
This revision is now accepted and ready to land.Apr 13 2021, 11:24 AM
Closed by commit rG9345f9fa5d64: [TableGen] [docs] Correct a reference in the TableGen Overview document (authored by Paul-C-Anagnostopoulos). · Explain WhyApr 15 2021, 6:27 AM
This revision was automatically updated to reflect the committed changes.
Paul-C-Anagnostopoulos added a commit: rG9345f9fa5d64: [TableGen] [docs] Correct a reference in the TableGen Overview document.

Revision Contents

PathSize
llvm/
docs/
TableGen/
15 lines

Diff 337134

llvm/docs/TableGen/index.rst

Show All 19 Lines
records, it is specifically designed to allow writing flexible descriptions and records, it is specifically designed to allow writing flexible descriptions and
for common features of these records to be factored out. This reduces the for common features of these records to be factored out. This reduces the
amount of duplication in the description, reduces the chance of error, and makes amount of duplication in the description, reduces the chance of error, and makes
it easier to structure domain specific information. it easier to structure domain specific information.
The TableGen front end parses a file, instantiates the declarations, and The TableGen front end parses a file, instantiates the declarations, and
hands the result off to a domain-specific `backend`_ for processing. See hands the result off to a domain-specific `backend`_ for processing. See
the :doc:`TableGen Programmer's Reference <./ProgRef>` for an in-depth the :doc:`TableGen Programmer's Reference <./ProgRef>` for an in-depth
description of TableGen. See :doc:`xxx-tblgen - Target Description to C++ description of TableGen. See :doc:`tblgen - Description to C++ Code
Code <../CommandGuide/tblgen>` for details on the various <../CommandGuide/tblgen>` for details on the ``*-tblgen`` commands
``xxx-tblgen`` commands that invoke TableGen. that run the various flavors of TableGen.
The current major users of TableGen are :doc:`The LLVM Target-Independent The current major users of TableGen are :doc:`The LLVM Target-Independent
Code Generator <../CodeGenerator>` and the `Clang diagnostics and attributes Code Generator <../CodeGenerator>` and the `Clang diagnostics and attributes
<https://clang.llvm.org/docs/UsersManual.html#controlling-errors-and-warnings>`_. <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 Note that if you work with TableGen frequently and use emacs or vim,
an emacs "TableGen mode" and a vim language file in the ``llvm/utils/emacs`` and you can find an emacs "TableGen mode" and a vim language file in the
``llvm/utils/vim`` directories of your LLVM distribution, respectively. ``llvm/utils/emacs`` and ``llvm/utils/vim`` directories of your LLVM
distribution, respectively.
.. _intro: .. _intro:
The TableGen program The TableGen program
==================== ====================
TableGen files are interpreted by the TableGen program: `llvm-tblgen` available TableGen files are interpreted by the TableGen program: `llvm-tblgen` available
▲ Show 20 Lines • Show All 211 Lines • ▼ Show 20 Lines
.. _backend: .. _backend:
.. _backends: .. _backends:
TableGen backends TableGen backends
================= =================
TableGen files have no real meaning without a backend. The default operation 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 that's only useful for debugging the TableGen files themselves. The power
in TableGen is, however, to interpret the source files into an internal in TableGen is, however, to interpret the source files into an internal
representation that can be generated into anything you want. representation that can be generated into anything you want.
Current usage of TableGen is to create huge include files with tables that you Current usage of TableGen is to create huge include files with tables that you
can either include directly (if the output is in the language you're coding), can either include directly (if the output is in the language you're coding),
or be used in pre-processing via macros surrounding the include of the file. or be used in pre-processing via macros surrounding the include of the file.
Show All 28 Lines