Skip to content

Commit 986c7df

Browse files
committed
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 llvm-svn: 359714
1 parent 31f7c4a commit 986c7df

File tree

4 files changed

+12
-13
lines changed

4 files changed

+12
-13
lines changed

llvm/docs/PDB/DbiStream.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,8 @@ further guidance.
105105

106106
- **PdbDllRbld** - Unknown
107107

108-
- **MFCTypeServerIndex** - The length of the :ref:dbi_mfc_type_server_substream
108+
- **MFCTypeServerIndex** - The length of the
109+
:ref:`dbi_mfc_type_server_substream`.
109110

110111
- **Flags** - A bitfield with the following layout, containing various
111112
information about how the program was built:

llvm/docs/PDB/TpiStream.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -286,8 +286,8 @@ accurate.
286286
within the TPI Hash Stream of the Type Index Offsets Buffer. This is a list of
287287
pairs of uint32_t's where the first value is a :ref:`Type Index <type_indices>`
288288
and the second value is the offset in the type record data of the type with this
289-
index. This can be used to do a binary search followed bin a linear search to
290-
get amortized O(log n) lookup by type index.
289+
index. This can be used to do a binary search followed by a linear search to
290+
get O(log n) lookup by type index.
291291

292292
- **HashAdjBufferOffset / HashAdjBufferLength** - The offset and size within
293293
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
308308
of such records (e.g. the length of the array) can be determined by computing the
309309
value ``Header.TypeIndexEnd - Header.TypeIndexBegin``.
310310

311-
log(n) random access is provided by way of the Type Index Offsets array (if present)
312-
described previously.
311+
O(log(n)) access is provided by way of the Type Index Offsets array (if
312+
present) described previously.

llvm/docs/PDB/index.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -60,13 +60,12 @@ File Layout
6060

6161
The MSF Container
6262
-----------------
63-
A PDB file is really just a special case of an MSF (Multi-Stream Format) file.
64-
An MSF file is actually a miniature "file system within a file". It contains
65-
multiple streams (aka files) which can represent arbitrary data, and these
66-
streams are divided into blocks which may not necessarily be contiguously
67-
laid out within the file (aka fragmented). Additionally, the MSF contains a
68-
stream directory (aka MFT) which describes how the streams (files) are laid
69-
out within the MSF.
63+
A PDB file is an MSF (Multi-Stream Format) file. An MSF file is a "file system
64+
within a file". It contains multiple streams (aka files) which can represent
65+
arbitrary data, and these streams are divided into blocks which may not
66+
necessarily be contiguously laid out within the MSF container file.
67+
Additionally, the MSF contains a stream directory (aka MFT) which describes how
68+
the streams (files) are laid out within the MSF.
7069

7170
For more information about the MSF container format, stream directory, and
7271
block layout, see :doc:`MsfFile`.

llvm/include/llvm/DebugInfo/PDB/Native/RawTypes.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -341,7 +341,6 @@ struct SrcHeaderBlockEntry {
341341
short Padding; // Pad to 4 bytes.
342342
char Reserved[8];
343343
};
344-
345344
static_assert(sizeof(SrcHeaderBlockEntry) == 40, "Incorrect struct size!");
346345

347346
} // namespace pdb

0 commit comments

Comments
 (0)