Skip to content
This repository was archived by the owner on Apr 27, 2023. It is now read-only.

Update README.md #38

Open
amogh-gulati wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md #38

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a149768
Update README.md
amogh-gulati Oct 29, 2018
42b3929
Update README.md
amogh-gulati Oct 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ The PDB format has not been officially documented, presenting a challenge for ot
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
The majority of content on this repository 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
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.

##Start here
<h2>Start here</h2>
Copy link

@tsafin tsafin Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This makes no much sense, and sounds less markdown-ish, IMVHO.

It doesn't work though in their current form because of lack of space between ## and text

Copy link
Author

@amogh-gulati amogh-gulati Oct 29, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have just started with open source and some school seniors suggested to start contributing in any form you can. I thought I could help with the readability of the readme here, though in retrospection should have gone through some more resources about it. Also realized that microsoft is really not a place for a bigenner lol. Any advice for a noobie or feedback is greatly appreciated.
Thanks.

The file pdb.h (on in langapi), provides the API surface for mscorpdb.dll, which we ship with every compiler and toolset.

Important points:
Expand All @@ -36,7 +36,7 @@ A tool that I thought we also ship that would easily verify your “empty” PDB

So in summary, by using the externally defined function entry points in pdb.h you can call into mscorpdb.dll.

##What is a PDB
<h2>What is a PDB</h2><br>
Copy link

@tsafin tsafin Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same here - to make 2nd level title it should be

## What is a PDB

(pay attention to the space between ## and title)

Copy link
Author

@amogh-gulati amogh-gulati Oct 29, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

working on it asap


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.

Expand Down