Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention requirements for symbol packages (.snupkg) #229

Closed
cremor opened this issue Jan 15, 2019 · 1 comment
Closed

Mention requirements for symbol packages (.snupkg) #229

cremor opened this issue Jan 15, 2019 · 1 comment

Comments

@cremor
Copy link

cremor commented Jan 15, 2019

The readme was recently changed to use the new NuGet symbol packages (.snupkg) instead of embedding the PDB in the main NuGet package. While this new symbol server is nice, it has a few disadvantages:

  1. It only supports portable PDBs (SourceLink itself supports all PDB formats)
  2. It requires VS 2017 15.9 to build or to consume the symbol packages (SourceLink only requires 15.3)
  3. It requires the user to manually add the NuGet symbol server in the VS settings (embedded symbols don't require any settings)

In my opinion these requirements should be listed in the readme, otherwise users (both library authors and consumers) might wonder why SourceLink isn't working for them.
Maybe even mention both ways - embedded PDB files and the NuGet symbol server - to give the library author the choice.

Note that the official open source library-guidance also still recommends embedded PDB files over the new NuGet symbol server.

@tmat
Copy link
Member

tmat commented Jan 28, 2019

Note that the official open source library-guidance also still recommends embedded PDB files over the new NuGet symbol server.

The doc has been updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants