Skip to content

Clarify debugging requirements when embedding symbols in NuGet packages #56613

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.

Sign up for GitHub

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

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

Clarify debugging requirements when embedding symbols in NuGet packages #56613

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions docs/standard/library-guidance/nuget.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,9 @@ An alternative to creating a symbol package is embedding symbol files in the mai

The downside of embedding symbol files is that they increase the package size by about 30% for .NET libraries compiled using SDK-style projects. If package size is a concern, you should publish symbols in a symbol package instead.

> [!NOTE]
> Embedding symbol files (`*.pdb`) in a package only provides debug symbols with source file paths from the build machine. To enable consumers to step into source code when debugging on another machine, configure [Source Link](sourcelink.md) or embed the source code files by setting `<EmbedAllSources>true</EmbedAllSources>`.

✔️ CONSIDER publishing symbols as a symbol package (`*.snupkg`) to NuGet.org

> Symbol packages (`*.snupkg`) provide developers a good on-demand debugging experience without bloating the main package size and impacting restore performance for those who don't intend to debug the NuGet package.
Expand Down
Loading