Add documentation for the LLVM IR dialect
authorAlex Zinenko <zinenko@google.com>
Fri, 22 Feb 2019 09:00:25 +0000 (01:00 -0800)
committerjpienaar <jpienaar@google.com>
Fri, 29 Mar 2019 23:37:26 +0000 (16:37 -0700)
commitf0597cbf9f03a797bea636741bf152491859d4d7
tree6860c6456fb46598cad3f5151188d06e980e040d
parent3e656599f1c1ab2d4b810ba054d59c99d5628b35
Add documentation for the LLVM IR dialect

The LLVM IR pass was bootstrapped without user documentation, following LLVM's
language reference and existing conversions between MLIR standard operations
and LLVM IR instructions.  Provide concise documentation of the LLVM IR dialect
operations.  This documentation does not describe the semantics of the
operations, which should match that of LLVM IR, but highlights the structural
differences in operation definitions, in particular using attributes instead of
constant-only values.  It also describes pseudo-operations that exist only to
make the LLVM IR dialect self-contained within MLIR.

While it could have been possible to generate operation description from
TableGen, this opts for a more concise format where groups of related
operations are described together.

PiperOrigin-RevId: 235149136
mlir/g3doc/Dialects/LLVM.md [new file with mode: 0644]