Minor tweaks to PDB docs

- Fix a broken link
- Some spelling fixes
- Remove an unnecessary "amortized"
- Don't say "log(n) random access"; "random access" means O(1)
- Make MSF overview a bit more concise

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

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@359714 91177308-0d34-0410-b5e6-96231b3b80d8

diff --git a/docs/PDB/DbiStream.rst b/docs/PDB/DbiStream.rst
index 71cf9e98596d7dc6f4523ed9b32e71b7f2f2d847..90c8d7ade8b5edc07a4294e5521d339d3c08a7d3 100644 (file)
--- a/docs/PDB/DbiStream.rst
+++ b/docs/PDB/DbiStream.rst
@@ -105,7 +105,8 @@ further guidance.
   
 - **PdbDllRbld** - Unknown
 
-- **MFCTypeServerIndex** - The length of the :ref:dbi_mfc_type_server_substream
+- **MFCTypeServerIndex** - The length of the
+  :ref:`dbi_mfc_type_server_substream`.
 
 - **Flags** - A bitfield with the following layout, containing various
   information about how the program was built:

diff --git a/docs/PDB/TpiStream.rst b/docs/PDB/TpiStream.rst
index 314f688d108cabd493cce73d529eeab8d11f2bfe..8f6fd12daf22eb33f3b1cb4705d529986c69b81b 100644 (file)
--- a/docs/PDB/TpiStream.rst
+++ b/docs/PDB/TpiStream.rst
@@ -286,8 +286,8 @@ accurate.
   within the TPI Hash Stream of the Type Index Offsets Buffer.  This is a list of
   pairs of uint32_t's where the first value is a :ref:`Type Index <type_indices>`
   and the second value is the offset in the type record data of the type with this
-  index.  This can be used to do a binary search followed bin a linear search to
-  get amortized O(log n) lookup by type index.
+  index.  This can be used to do a binary search followed by a linear search to
+  get O(log n) lookup by type index.
 
 - **HashAdjBufferOffset / HashAdjBufferLength** - The offset and size within
   the TPI hash stream of a serialized hash table whose keys are the hash values
@@ -308,5 +308,5 @@ variable length array of :doc:`CodeView type records <CodeViewTypes>`.  The numb
 of such records (e.g. the length of the array) can be determined by computing the
 value ``Header.TypeIndexEnd - Header.TypeIndexBegin``.
 
-log(n) random access is provided by way of the Type Index Offsets array (if present)
-described previously.
+O(log(n)) access is provided by way of the Type Index Offsets array (if
+present) described previously.

diff --git a/docs/PDB/index.rst b/docs/PDB/index.rst
index 88e6015642abb6f830d268c403d583dc0ea7dcb3..8425b294442c7985345bd2dd2d5e2bf63fe0dcdf 100644 (file)
--- a/docs/PDB/index.rst
+++ b/docs/PDB/index.rst
@@ -60,13 +60,12 @@ File Layout
 
 The MSF Container
 -----------------
-A PDB file is really just a special case of an MSF (Multi-Stream Format) file.
-An MSF file is actually a miniature "file system within a file".  It contains
-multiple streams (aka files) which can represent arbitrary data, and these
-streams are divided into blocks which may not necessarily be contiguously
-laid out within the file (aka fragmented).  Additionally, the MSF contains a
-stream directory (aka MFT) which describes how the streams (files) are laid
-out within the MSF.
+A PDB file is an MSF (Multi-Stream Format) file.  An MSF file is a "file system
+within a file".  It contains multiple streams (aka files) which can represent
+arbitrary data, and these streams are divided into blocks which may not
+necessarily be contiguously laid out within the MSF container file.
+Additionally, the MSF contains a stream directory (aka MFT) which describes how
+the streams (files) are laid out within the MSF.
 
 For more information about the MSF container format, stream directory, and
 block layout, see :doc:`MsfFile`.

diff --git a/include/llvm/DebugInfo/PDB/Native/RawTypes.h b/include/llvm/DebugInfo/PDB/Native/RawTypes.h
index e2d4ae44ee6761a9ae1d25ede5d929a8d790f7f4..6119e6e5db26a698d459e41245fd425448d62d12 100644 (file)
--- a/include/llvm/DebugInfo/PDB/Native/RawTypes.h
+++ b/include/llvm/DebugInfo/PDB/Native/RawTypes.h
@@ -341,7 +341,6 @@ struct SrcHeaderBlockEntry {
   short Padding;                 // Pad to 4 bytes.
   char Reserved[8];
 };
-
 static_assert(sizeof(SrcHeaderBlockEntry) == 40, "Incorrect struct size!");
 
 } // namespace pdb