[llvm] r322198 - [MIR] Update MIRLangRef with documentation on bundled instructions

[Francis Visoiu Mistrih via llvm-commits]

Author: thegameg
Date: Wed Jan 10 09:53:16 2018
New Revision: 322198

URL: http://llvm.org/viewvc/llvm-project?rev=322198&view=rev
Log:
[MIR] Update MIRLangRef with documentation on bundled instructions

Differential Revision: https://reviews.llvm.org/D41872

Modified:
    llvm/trunk/docs/MIRLangRef.rst

Modified: llvm/trunk/docs/MIRLangRef.rst
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/MIRLangRef.rst?rev=322198&r1=322197&r2=322198&view=diff
==============================================================================
--- llvm/trunk/docs/MIRLangRef.rst (original)
+++ llvm/trunk/docs/MIRLangRef.rst Wed Jan 10 09:53:16 2018
@@ -378,6 +378,21 @@ instruction's name:
 
 .. _registers:
 
+Bundled Instructions
+^^^^^^^^^^^^^^^^^^^^
+
+The syntax for bundled instructions is the following:
+
+.. code-block:: text
+
+    BUNDLE implicit-def %r0, implicit-def %r1, implicit %r2 {
+      %r0 = SOME_OP %r2
+      %r1 = ANOTHER_OP internal %r0
+    }
+
+The first instruction is often a bundle header. The instructions between ``{``
+and ``}`` are bundled with the first instruction.
+
 Registers
 ---------
 
@@ -743,7 +758,6 @@ For an int eq predicate ``ICMP_EQ``, the
 
 .. TODO: Describe the parsers default behaviour when optional YAML attributes
    are missing.
-.. TODO: Describe the syntax for the bundled instructions.
 .. TODO: Describe the syntax for virtual register YAML definitions.
 .. TODO: Describe the machine function's YAML flag attributes.
 .. TODO: Describe the syntax for the register mask machine operands.