more tweaks
[oota-llvm.git] / docs / BitCodeFormat.html
index 54b9361c37982574fe7fe0cba9495fd07ec30905..15b05230d020712d3ddf43be1ef9e3e169044166 100644 (file)
@@ -462,23 +462,23 @@ emitted as their code, followed by the extra data.
 <p>The possible operand encodings are:</p>
 
 <ol>
-<li value="1">Fixed: The field should be emitted as
+<li>Fixed: The field should be emitted as
     a <a href="#fixedwidth">fixed-width value</a>, whose width is specified by
     the operand's extra data.</li>
-<li value="2">VBR: The field should be emitted as
+<li>VBR: The field should be emitted as
     a <a href="#variablewidth">variable-width value</a>, whose width is
     specified by the operand's extra data.</li>
-<li value="3">Array: This field is an array of values.  The array operand
+<li>Array: This field is an array of values.  The array operand
     has no extra data, but expects another operand to follow it which indicates
     the element type of the array.  When reading an array in an abbreviated
     record, the first integer is a vbr6 that indicates the array length,
     followed by the encoded elements of the array.  An array may only occur as
     the last operand of an abbreviation (except for the one final operand that
     gives the array's type).</li>
-<li value="4">Char6: This field should be emitted as
+<li>Char6: This field should be emitted as
     a <a href="#char6">char6-encoded value</a>.  This operand type takes no
     extra data.</li>
-<li value="5">Blob: This field is emitted as a vbr6, followed by padding to a
+<li>Blob: This field is emitted as a vbr6, followed by padding to a
     32-bit boundary (for alignment) and an array of 8-bit objects.  The array of
     bytes is further followed by tail padding to ensure that its total length is
     a multiple of 4 bytes.  This makes it very efficient for the reader to
@@ -563,6 +563,8 @@ blocks.  The currently specified records are:
 <pre>
 [SETBID (#1), blockid]
 [DEFINE_ABBREV, ...]
+[BLOCKNAME, ...name...]
+[SETRECORDNAME, RecordID, ...name...]
 </pre>
 </div>
 
@@ -582,6 +584,15 @@ in <tt>BLOCKINFO</tt> blocks receive abbreviation IDs as described
 in <tt><a href="#DEFINE_ABBREV">DEFINE_ABBREV</a></tt>.
 </p>
 
+<p>The <tt>BLOCKNAME</tt> can optionally occur in this block.  The elements of
+the record are the bytes for the string name of the block.  llvm-bcanalyzer uses
+this to dump out bitcode files symbolically.</p>
+
+<p>The <tt>SETRECORDNAME</tt> record can optionally occur in this block.  The
+first entry is a record ID number and the rest of the elements of the record are
+the bytes for the string name of the record.  llvm-bcanalyzer uses
+this to dump out bitcode files symbolically.</p>
+
 <p>
 Note that although the data in <tt>BLOCKINFO</tt> blocks is described as
 "metadata," the abbreviations they contain are essential for parsing records