[PATCH] D11736: Initial documentation for the MIR serialization format.

[Sean Silva]

silvas accepted this revision.
silvas added a comment.
This revision is now accepted and ready to land.

LGTM, but a couple comments/questions.


================
Comment at: docs/MachineIRRef.rst:41-42
@@ +40,4 @@
+
+When the first YAML document contains a `YAML block literal string
+<http://www.yaml.org/spec/1.2/spec.html#id2795688>`_, the MIR parser will
+treat this string as an LLVM assembly language string that represents an
----------------
Do you actually depend on it being a block literal string? I thought that that was just syntax sugar in the YAML language, so that really any string should be fine (although the block literal string is probably easiest to read)

================
Comment at: docs/MachineIRRef.rst:83-94
@@ +82,14 @@
+
+The document above consists of attributes that represent the various
+properties and data structures in a machine function.
+
+The attribute ``name`` is required, and its value should be identical to the
+name of a function that this machine function is based on.
+
+The attribute ``body`` contains a list of YAML mappings that represent the
+function's machine basic blocks.
+
+The first machine basic block in the ``body`` list above contains the attribute
+``instructions``. This attribute stores a list of string literals which
+represent the machine instructions for that basic block.
+
----------------
Please add specific TODO's here for everything that is merely touched on (but that you know you eventually need to expand on) so that nothing falls through the cracks.


Repository:
  rL LLVM

http://reviews.llvm.org/D11736