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

Refactor "PDB distributions" section of README #1271

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

MattKotsenas
Copy link
Member

Refactor the "PDB distributions" section of the README so that:

  • There's less bouncing back and forth between text (specifically shrinking the distance between introducing a .snupkg and talking about the limitations)
  • Add text offering embedded as a solution when .snupkgs don't work. I think for Source Link users this should be preferred over including .pdbs in the package because that requires consumers to know and set CopyDebugSymbolFilesFromPackages
  • Use GitHub markdown tags for asides or secondary information

@MattKotsenas
Copy link
Member Author

MattKotsenas commented Aug 28, 2024

I originally wrote this change as part of #1270, but separated it into its own PR since this one is a bit more nuanced and contains some opinions instead of just facts.

More specifically, the only downside I see for advocating for embedded pdbs over separate files included in the main package is it's easier to strip separate files for people that really care about size. I'm not convinced that requiring every consumer to opt-in via CopyDebugSymbolFilesFromPackages is a good tradeoff though, and they should instead either publish on a platform that supports snupkg or use another solution like symbol servers.

@MattKotsenas
Copy link
Member Author

@tmat, would you mind taking a look at this when you have a second? If you have any questions or concerns, please let me know. Thanks!


Alternatively, you can include PDB files in the main NuGet package by setting the following property in your project:

```xml
Copy link
Member

Choose a reason for hiding this comment

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

I would suggest including portable PDBs in the nupkg first and embedding PDBs into the assembly as an alternative. The latter increases size of the assembly, which may potentially be an issue in some cases.

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

Successfully merging this pull request may close these issues.

2 participants