Commit Graph

20 Commits

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

llvm-svn: 371860
2019-09-13 14:58:24 +00:00
Nico Weber ae02f6b594 PDB docs: Delete trailing whitespace, wrap to 80 cols
llvm-svn: 364131
2019-06-22 11:23:01 +00:00
Nico Weber 735953ea8b 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.

llvm-svn: 359721
2019-05-01 20:00:45 +00:00
Nico Weber 986c7dfa9f 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
2019-05-01 19:29:30 +00:00
Nico Weber 0a4aeec16e Convert PDB docs to unix line endings. No other changes.
llvm-svn: 359712
2019-05-01 19:15:05 +00:00
Zachary Turner e1bc9758cb [PDB Docs] Add some prose describing public and global symbols.
llvm-svn: 358289
2019-04-12 15:51:40 +00:00
Zachary Turner 4afa6dcabe [PDB Docs] Add skeleton of documentation for CodeView symbols.
llvm-svn: 358197
2019-04-11 17:29:48 +00:00
Zachary Turner 5a736c9bbf [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.

llvm-svn: 358119
2019-04-10 18:26:51 +00:00
Zachary Turner 6bafd5b3f7 [PDB Docs] Clarifications and fixes for DBI Stream.
llvm-svn: 358022
2019-04-09 17:38:34 +00:00
Zachary Turner cb70fe1c69 [PDB Docs] Add documentation for the hash table format.
llvm-svn: 357826
2019-04-05 22:09:30 +00:00
Zachary Turner 91d6caf6ec [PDB Docs] The IPI Stream actually has index 4.
llvm-svn: 357825
2019-04-05 22:09:14 +00:00
Zachary Turner bcf7f3c573 [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.

llvm-svn: 357819
2019-04-05 21:16:00 +00:00
Zachary Turner 5eeb28f8e0 [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.

llvm-svn: 357788
2019-04-05 17:59:26 +00:00
Zachary Turner d248f02795 [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.

llvm-svn: 357784
2019-04-05 17:12:37 +00:00
Zachary Turner 85cc79551d Add documentation for PDB TPI/IPI Stream.
llvm-svn: 357777
2019-04-05 16:43:42 +00:00
Zachary Turner 89d0889bf4 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

llvm-svn: 322404
2018-01-12 21:42:39 +00:00
Zachary Turner 3f0627c5e4 Add documentation for the PDB Module Info stream.
llvm-svn: 288205
2016-11-29 22:14:56 +00:00
Zachary Turner c316ddcd81 [PDB] Add documentation for the DBI Stream.
Differential Revision: https://reviews.llvm.org/D26552

llvm-svn: 286853
2016-11-14 17:59:28 +00:00
Zachary Turner 32e1edecba [PDB] Add documentation for the PDB Stream.
https://reviews.llvm.org/D26516

llvm-svn: 286852
2016-11-14 17:59:21 +00:00
Zachary Turner 218ce83f0b [PDB] Begin adding documentation for the PDB file format.
Differential Revision: https://reviews.llvm.org/D26374

llvm-svn: 286491
2016-11-10 19:24:21 +00:00