Skip to content

Commit

Permalink
Switch back to embedded PDBs.
Browse files Browse the repository at this point in the history 
The DLL size increase is not large, platforms where this package would be deployed can support it, and it improves debuggability by default.

See discussion at dotnet/docs#9110 (comment) and dotnet/sdk#2679 (comment).
  • Loading branch information
@bgrainger
bgrainger committed Nov 20, 2018
1 parent bd07ea6 commit 2ff0a1a
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions src/Directory.Build.props
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,10 @@
<PackageIconUrl>https://mysql-net.github.io/MySqlConnector/img/logo.png</PackageIconUrl>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/mysql-net/MySqlConnector.git</RepositoryUrl>
<DebugType>portable</DebugType>
<DebugType>embedded</DebugType>

This comment has been minimized.

Sign in to view

Copy link
@ctaggart

ctaggart Nov 21, 2018

The guidance is to embed add the portable pdb files in the NuGet package, not set embed the pdb files in the dll files which is what <DebugType>embedded</DebugType> does.

This comment has been minimized.

Sign in to view

Copy link
@bgrainger

bgrainger Nov 21, 2018

Author Member

Hmm, maybe I misread what people were saying ("embedded" is an overloaded term), but is there a compelling reason to avoid <DebugType>embedded</DebugType> PDBs? From my perspective, my consumers are guaranteed to have the symbols deployed to production (no worry if the PDB was deployed or not), so I'm guaranteed to get better call stacks in bug reports.

For examples of call stacks "in the wild" see these SO questions.

This comment has been minimized.

Sign in to view

Copy link
@bgrainger

bgrainger Nov 21, 2018

Author Member

BTW, thanks for all your work on SourceLink; it's really improved the .NET debugging experience!
<LangVersion>latest</LangVersion>
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
</PropertyGroup>

<ItemGroup>
Expand Down

1 comment on commit 2ff0a1a

@ctaggart
Copy link

Choose a reason for hiding this comment

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

Great to hear that, thanks! I like embedded for those reasons too, but we settled on portable. Tooling support was better.

Please sign in to comment.