[PATCH] D26552: [PDB] Add documentation for the PDB DBI Stream.

[Adrian McCarthy via llvm-commits]

amccarth added a comment.

Good content.  I have just a couple wording nits.



================
Comment at: docs/PDB/DbiStream.rst:17
+were used to link together the program, the source files which were used
+to build the program, as well as containing references to other streams that
+contain more detailed information about each compiland, such as the CodeView
----------------
"containing" here is redundant and a tad confusing.


================
Comment at: docs/PDB/DbiStream.rst:80
+- **BuildNumber** - A bitfield containing values representing the major and minor
+  version number of the toolchain (e.g., 12.0 for MSVC 2013) used to build the
+  program, with the following layout:
----------------
Consistency nit:  Elsewhere, you've been using `e.g.` and `i.e.` without a comma.


================
Comment at: docs/PDB/DbiStream.rst:87
+  uint16_t MajorVersion : 7;
+  uint16_t NewVersionFormat : 1;
+
----------------
Bit-field syntax is ambiguous because bit-fields can be allocated left-to-right or right-to-left (implementation defined).  There are also implementation-defined padding and alignment issues.


================
Comment at: docs/PDB/DbiStream.rst:129
+
+Immediately after the fixed size DBI Stream header are ``7`` of variable length
+`substreams`.  The following ``7`` fields of the DBI Stream header specify the
----------------
There's a wording problem here that makes this confusing.  My first instinct would be to delete the `of`, but I'm not sure if that's exactly what you meant.

Also, you probably should have a hyphens in `fixed-size` and `variable-length`.


================
Comment at: docs/PDB/DbiStream.rst:161
+Begins at offset ``0`` immediately after the :ref:`header <dbi_header>`.  The
+module info substream is an array of variable length records, each one
+describing a single module (e.g. object file) linked into the program.  Each
----------------
hyphen:  `variable-length`


https://reviews.llvm.org/D26552