6502/llvm-6502
1
0
Fork 0
mirror of https://github.com/c64scene-ar/llvm-6502.git synced 2024-07-09 10:29:25 +00:00
Code Issues Projects Releases Wiki Activity

Documentation for tblgen: formatting

Browse Source 
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@168904 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko 2012-11-29 17:41:05 +00:00
parent e26b62cb61
commit 6a144e40b0
1 changed files with 41 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

139
docs/CommandGuide/tblgen.rst
View File

@ -1,186 +1,129 @@
tblgen - Target Description To C++ Code Generator tblgen - Target Description To C++ Code Generator
================================================= =================================================
SYNOPSIS SYNOPSIS
-------- --------
:program:`tblgen` [*options*] [*filename*]
**tblgen** [*options*] [*filename*]
DESCRIPTION DESCRIPTION
----------- -----------
:program:`tblgen` translates from target description (``.td``) files into C++
code that can be included in the definition of an LLVM target library. Most
users of LLVM will not need to use this program. It is only for assisting with
writing an LLVM target backend.
**tblgen** translates from target description (.td) files into C++ code that can The input and output of :program:`tblgen` is beyond the scope of this short
be included in the definition of an LLVM target library. Most users of LLVM will introduction. Please see :doc:`../TableGenFundamentals`.
not need to use this program. It is only for assisting with writing an LLVM
target backend.
The input and output of **tblgen** is beyond the scope of this short
introduction. Please see the *CodeGeneration* page in the LLVM documentation.
The *filename* argument specifies the name of a Target Description (.td) file
to read as input.
The *filename* argument specifies the name of a Target Description (``.td``)
file to read as input.
OPTIONS OPTIONS
------- -------
.. option:: -help
**-help**
Print a summary of command line options. Print a summary of command line options.
.. option:: -o filename
Specify the output file name. If ``filename`` is ``-``, then
:program:`tblgen` sends its output to standard output.
**-o** *filename* .. option:: -I directory
Specify the output file name. If *filename* is ``-``, then **tblgen** Specify where to find other target description files for inclusion. The
sends its output to standard output. ``directory`` value should be a full or partial path to a directory that
contains target description files.
.. option:: -asmparsernum N
Make -gen-asm-parser emit assembly writer number ``N``.
**-I** *directory* .. option:: -asmwriternum N
Specify where to find other target description files for inclusion. The Make -gen-asm-writer emit assembly writer number ``N``.
*directory* value should be a full or partial path to a directory that contains
target description files.
.. option:: -class className
**-asmparsernum** *N*
Make -gen-asm-parser emit assembly writer number *N*.
**-asmwriternum** *N*
Make -gen-asm-writer emit assembly writer number *N*.
**-class** *class Name*
Print the enumeration list for this class. Print the enumeration list for this class.
.. option:: -print-records
**-print-records**
Print all records to standard output (default). Print all records to standard output (default).
.. option:: -print-enums
**-print-enums**
Print enumeration values for a class Print enumeration values for a class
.. option:: -print-sets
**-print-sets**
Print expanded sets for testing DAG exprs. Print expanded sets for testing DAG exprs.
.. option:: -gen-emitter
**-gen-emitter**
Generate machine code emitter. Generate machine code emitter.
.. option:: -gen-register-info
**-gen-register-info**
Generate registers and register classes info. Generate registers and register classes info.
.. option:: -gen-instr-info
**-gen-instr-info**
Generate instruction descriptions. Generate instruction descriptions.
.. option:: -gen-asm-writer
**-gen-asm-writer**
Generate the assembly writer. Generate the assembly writer.
.. option:: -gen-disassembler
**-gen-disassembler**
Generate disassembler. Generate disassembler.
.. option:: -gen-pseudo-lowering
**-gen-pseudo-lowering**
Generate pseudo instruction lowering. Generate pseudo instruction lowering.
.. option:: -gen-dag-isel
**-gen-dag-isel**
Generate a DAG (Directed Acycle Graph) instruction selector. Generate a DAG (Directed Acycle Graph) instruction selector.
.. option:: -gen-asm-matcher
**-gen-asm-matcher**
Generate assembly instruction matcher. Generate assembly instruction matcher.
.. option:: -gen-dfa-packetizer
**-gen-dfa-packetizer**
Generate DFA Packetizer for VLIW targets. Generate DFA Packetizer for VLIW targets.
.. option:: -gen-fast-isel
**-gen-fast-isel**
Generate a "fast" instruction selector. Generate a "fast" instruction selector.
.. option:: -gen-subtarget
**-gen-subtarget**
Generate subtarget enumerations. Generate subtarget enumerations.
.. option:: -gen-intrinsic
**-gen-intrinsic**
Generate intrinsic information. Generate intrinsic information.
.. option:: -gen-tgt-intrinsic
**-gen-tgt-intrinsic**
Generate target intrinsic information. Generate target intrinsic information.
.. option:: -gen-enhanced-disassembly-info
**-gen-enhanced-disassembly-info**
Generate enhanced disassembly info. Generate enhanced disassembly info.
.. option:: -version
**-version**
Show the version number of this program. Show the version number of this program.
EXIT STATUS EXIT STATUS
----------- -----------
If :program:`tblgen` succeeds, it will exit with 0. Otherwise, if an error
If **tblgen** succeeds, it will exit with 0. Otherwise, if an error
occurs, it will exit with a non-zero value. occurs, it will exit with a non-zero value.