Source Index and pack .pdb files into regular .nupkg

[pranavkm]

Wherever we ship DLLs that are used in customer apps, we need to include the portable PDB along side it.

We need to include portable PDBs in:

• The shared framework
• The NUPKGs

And we need to do this in:

• 2.1.0-preview1
• dev

---

Original text:

From aspnet/dnx#380

The plan would be to create a single nupkg rather than a *.nupkg and *.symbols.nupkg as part of our build and use SourceLink to support having pdbs sit in the package.

[davidfowl]

So I think the steps would be to take the output of the build and generate a source linked pdb using the pdb from the .symbols package. When we unzip and rezip the package to tweak extra stuff, we should include the pdb source linked pdb in there pointing to the github sha.

[AndriySvyryd]

Note that including the pdbs in the .nupkg where VS can find them turns the corresponding dlls into “My Code”.

By default VS has Just My Code and break on user-unhandled exceptions enabled. This will cause the debugger to break on exceptions that cross "My Code" boundaries.

We found this out because we were including the symbols in the System.Data.SqlClient.nupkg, see dotnet/efcore#987

[ctaggart]

I just published a working version of SourceLink.exe. It should do what you need. Details:
ctaggart/SourceLink#53 (comment)

[ctaggart]

Hoping to provide better examples of using SourceLink.exe, I submitted an issue that shows how to index Sake.pdb and Sake.Engine.pdb sakeproject/sake#17.

Is there an API that I can access to get a list of files to compile in a project.json? If yes, I may be able to incorporate in SourceLink.exe. If not, use these two args instead:

        --pdb <string>: pdb file to add the index to, supports multiple and globs
        --file [-f] <string>: source file to put in the index, supports multiple and globs

For example --pdb the\path\to\the.pdb -f *\*.cs.

[ctaggart]

I just announced a stable SourceLink.exe and added documentation on how to use it.
http://blog.ctaggart.com/2015/03/announcing-sourcelinkexe.html
http://ctaggart.github.io/SourceLink/exe.html

Also be sure to check out the demo that demonstrates taking advantage of the source index at design time.
http://ctaggart.github.io/SourceLink/index.html#Demo-Go-To-Source-during-Design-Time

I would love to make progress on this ticket.

/cc @pranavkm @davidfowl

[ctaggart]

At the Microsoft MVP Summit, I spoke with several key individuals today and we've come up with a great plan for source indexing. The primary push right now is to get debugging to work cross-platform. The portable pdb format recently became 1.0 and Roslyn csc.exe can create them with a debug switch shipping with Visual Studio 2015 Update 1. The pdb's are much much more compact and cross platform (6 to 10 times). It would be great to included them in the nupkg files.

Open issues:

• I am working with @tmat to get the source index text file into the portable pdb file via Roslyn csc.exe
• the dnx build tool would use that Roslyn support, cc @anurse
• @yishaigalatzer and the NuGet team is going to look at using satellite nupkg files like they did for native packages for CoreCLR
• the Roslyn team will have a design discussion about identifying generated source files in a couple of weeks. (may be *.g.cs like Xamarin). The generated ones could be embedded in the pdb.

Simply including the portable pdb files with the nuget packages is a great first step.

[pranavkm]

cc @rynowak for symbro.

[ctaggart]

We can change the title of this to source link instead of source index. I rewrote SourceLink as a dotnet tool for version 2. It supports Portable PDB files and its new source link support.

I've added pull requests that should get you guys started for both aspnet.mvc aspnet/Mvc#5860 and EntityFramework dotnet/efcore#7726.

It was been agreed upon to include Portable PDB files in the nupkgs for source link support. Check out the fresh new documentation here: https://github.com/ctaggart/SourceLink

cc @davidfowl