From 10ddce527c43341480ea8eb4de21f3b22659fd72 Mon Sep 17 00:00:00 2001 From: Prateek Chaplot Date: Tue, 16 Oct 2018 11:51:55 +0530 Subject: [PATCH] Grammar Check --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7107811..4d6f978 100644 --- a/README.md +++ b/README.md @@ -6,19 +6,19 @@ This repo contains information from Microsoft about the PDB (Program Database) The intent here is to provide code that will show all the binary level formats and simple tools that can use the pdb. -Simply put ...We will make best efforts to role this foward with the new compilers and tools that we ship every release. We will continue to innovate and change binary API's and ABI's for all the Microsoft platforms and we will try to include the community by keeping this PDB repo in synch with the latest retail products (compilers,linkers,debuggers) just shipped. +Simply put ...We will make best efforts to role this forward with the new compilers and tools that we ship every release. We will continue to innovate and change binary API's and ABI's for all the Microsoft platforms and we will try to include the community by keeping this PDB repo in synch with the latest retail products (compilers,linkers,debuggers) just shipped. -By publishing this source code, we are by passing the publically documented API we provided for only reading a PDB - that was DIA +By publishing this source code, we are bypassing the publically documented API we provided for only reading a PDB - that was DIA https://msdn.microsoft.com/en-us/library/x93ctkx8.aspx -With this information we are now building the information for other compilers (and tools) to efficiently write a PDB. +With this information, we are now building the information for other compilers (and tools) to efficiently write a PDB. The PDB format has not been officially documented, presenting a challenge for other compilers and toolsets (such as Clang/LLVM) that want to work with Windows or the Visual Studio debugger. We want to help the Open Source compilers to get onto the Windows platform. The majority of content on this repo is presented as actual source files from the VC++ compiler -toolset. Source code is the ultimate documentation :-) We hope that you will find it helpful. If you +toolset. The source code is the ultimate documentation :-) We hope that you will find it helpful. If you find that you need other information to successfully complete your project, please enter an [Issue](https://github.com/microsoft/microsoft-pdb/issues) letting us know what information you need. @@ -27,18 +27,17 @@ The file pdb.h (on in langapi), provides the API surface for mscorpdb.dll, which Important points: -• Mscorpdb.dll is what our linker and compiler uses to create PDB files. +• Mscorpdb.dll is what our linker and compiler use to create PDB files. • Mscorpdb.dll implements the “stream” abstractions. -Also there is another file that we ship that should allow you to determine whether you have correctly produced an “empty” PDB which contains the minimal encoding to let another tool open and correctly parse that “empty” file. “Empty” really meaning a properl -y formated file where the sections contain the correct information to indicate zero records or symbols are present +Also, there is another file that we ship that should allow you to determine whether you have correctly produced an “empty” PDB which contains the minimal encoding to let another tool open and correctly parse that “empty” file. “Empty” really meaning a properly formatted file where the sections contain the correct information to indicate zero records or symbols are present A tool that I thought we also ship that would easily verify your “empty” PDB file is dia2dump.exe So in summary, by using the externally defined function entry points in pdb.h you can call into mscorpdb.dll. ##What is a PDB -PDBs are files with multiple ‘streams’ of information in them. You can almost assume each stream as an individual file, except that storing them as individual files is wasteful and inconvenient, hence this multiple streams approach. PDB streams are not NTFS streams though. They can be implemented as NTFS streams, but since they are to be made available on Win9X as well, they use a home brewed implementation. The implementation allows a primitive form of two-phase commit protocol. The writers of PDB files write what ever they want to in PDBs, but it won’t be committed until an explicit commit is issued. This allows the clients quite a bit of flexibility - say for example, a compiler can keep on writing information, and just not commit it, if it encounters an error in users’ source code. +PDBs are files with multiple ‘streams’ of information in them. You can almost assume each stream as an individual file, except that storing them as individual files is wasteful and inconvenient, hence these multiple streams approach. PDB streams are not NTFS streams though. They can be implemented as NTFS streams, but since they are to be made available on Win9X as well, they use a home-brewed implementation. The implementation allows a primitive form of two-phase commit protocol. The writers of PDB files write whatever they want to in PDBs, but it won’t be committed until an explicit commit is issued. This allows the clients quite a bit of flexibility - say, for example, a compiler can keep on writing information, and just not commit it, if it encounters an error in users’ source code. Each stream is identified with a unique stream number and an optional name. In a nutshell here’s how the PDB looks like -