20 Commits

Author SHA1 Message Date
Nico Weber
c562715303 Fix a few spellos in docs.
(Trying to debug an incremental build thing on a bot...)

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@371860 91177308-0d34-0410-b5e6-96231b3b80d8
2019-09-13 14:58:24 +00:00
Nico Weber
20428852cc PDB docs: Delete trailing whitespace, wrap to 80 cols
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@364131 91177308-0d34-0410-b5e6-96231b3b80d8
2019-06-22 11:23:01 +00:00
Nico Weber
97aed04cd1 Try to unbreak sphinx bot after r359714
The now-correctly-referenced label dbi_type_server_map_substream didn't
exist. Rewrite things a bit after looking at NewDBIHdr in dbi.h and its
use in dbi.cpp in the reference implementation.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@359721 91177308-0d34-0410-b5e6-96231b3b80d8
2019-05-01 20:00:45 +00:00
Nico Weber
a27c90973c 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
2019-05-01 19:29:30 +00:00
Nico Weber
52810e6419 Convert PDB docs to unix line endings. No other changes.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@359712 91177308-0d34-0410-b5e6-96231b3b80d8
2019-05-01 19:15:05 +00:00
Zachary Turner
324cbd6cc8 [PDB Docs] Add some prose describing public and global symbols.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@358289 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-12 15:51:40 +00:00
Zachary Turner
c4ffb0705d [PDB Docs] Add skeleton of documentation for CodeView symbols.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@358197 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-11 17:29:48 +00:00
Zachary Turner
091d3974cc [PDB Docs] Start documenting CodeView Type Records.
This puts the general layout of the document in place and fully
describes 1 simple type record.  Followups will fill out more
pieces.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@358119 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-10 18:26:51 +00:00
Zachary Turner
40b4c59816 [PDB Docs] Clarifications and fixes for DBI Stream.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@358022 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-09 17:38:34 +00:00
Zachary Turner
0e34344e6e [PDB Docs] Add documentation for the hash table format.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@357826 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-05 22:09:30 +00:00
Zachary Turner
903fc4e173 [PDB Docs] The IPI Stream actually has index 4.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@357825 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-05 22:09:14 +00:00
Zachary Turner
aeacd5adf4 [PDB Docs] Delete * LINKER * Stream information.
This is actually just a module debug info stream, so it should
technically be covered by a discussion of the module list.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@357819 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-05 21:16:00 +00:00
Zachary Turner
0651f46071 [PDB Docs] Finish documentation for PDB Info Stream.
The information about the named stream map and feature codes
was not present.  This patch adds it.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@357788 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-05 17:59:26 +00:00
Zachary Turner
65e5a02fa9 [PDB Docs] Add info about the hash adjustment buffer.
This necessitates adding a document describing the serialized
hash table format.  This document is currently empty, although
it will be filled out in followup patches.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@357784 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-05 17:12:37 +00:00
Zachary Turner
e28ea96f43 Add documentation for PDB TPI/IPI Stream.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@357777 91177308-0d34-0410-b5e6-96231b3b80d8
2019-04-05 16:43:42 +00:00
Zachary Turner
0b5677cbf8 Update MSF File Documentation.
This adds some more detail about the PDB container format,
specifically surrounding the layout of the Free Page Map.

Patch by Colden Cullen
Differential Revision: https://reviews.llvm.org/D41825

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@322404 91177308-0d34-0410-b5e6-96231b3b80d8
2018-01-12 21:42:39 +00:00
Zachary Turner
29916a15c8 Add documentation for the PDB Module Info stream.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@288205 91177308-0d34-0410-b5e6-96231b3b80d8
2016-11-29 22:14:56 +00:00
Zachary Turner
576eea861d [PDB] Add documentation for the DBI Stream.
Differential Revision: https://reviews.llvm.org/D26552

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@286853 91177308-0d34-0410-b5e6-96231b3b80d8
2016-11-14 17:59:28 +00:00
Zachary Turner
3b7c9b9cdb [PDB] Add documentation for the PDB Stream.
https://reviews.llvm.org/D26516

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@286852 91177308-0d34-0410-b5e6-96231b3b80d8
2016-11-14 17:59:21 +00:00
Zachary Turner
ab792ca2d9 [PDB] Begin adding documentation for the PDB file format.
Differential Revision: https://reviews.llvm.org/D26374

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@286491 91177308-0d34-0410-b5e6-96231b3b80d8
2016-11-10 19:24:21 +00:00