Implement SourceLink support #18968
Assignees
Labels
Projects
Milestone
Comments
haritha-mohan
added a commit
to haritha-mohan/xamarin-macios
that referenced
this issue
Feb 7, 2024
Fixes xamarin#18968 We provide a mapping to the checked in source files via SourceLink.json and the rest of the generated/untracked sources are embedded into the PDB to provide a more comprehensive debugging experience. Since we invoke CSC directly, there were a few workarounds that had to be implemented (ex: implementing a helper script to account for untracked sources instead of simply using the EmbedUntrackedSources MSBuild property). As for testing, the newly added support was validated via the sourcelink dotnet tool which confirmed all the sources in the PDB either had valid urls or were embedded. sourcelink test Microsoft.MacCatalyst.pdb —> sourcelink test passed: Microsoft.MacCatalyst.pdb The PDB size does increase in size after embedding; for example, Microsoft.MacCatalyst.pdb went from 5 MB to 15.7 MB. But considering it would significantly help improve the debugging experience, be consistent with Android’s offerings, and it’s a highlighted attribute on the NuGet package explorer I think it’s a worthy size increase. Refs: xamarin/xamarin-android#7298 dotnet/roslyn#12625 https://github.com/dotnet/sourcelink/tree/main/docs
haritha-mohan
added a commit
that referenced
this issue
Feb 26, 2024
Fixes #18968 We provide a mapping to the checked in source files via SourceLink.json and the rest of the generated/untracked sources are embedded into the PDB to provide a more comprehensive debugging experience. Since we invoke CSC directly, there were a few workarounds that had to be implemented (ex: implementing a helper script to account for untracked sources instead of simply using the EmbedUntrackedSources MSBuild property). As for testing, the newly added support was validated via the dotnet sourcelink tool which confirmed all the sources in the PDB either had valid urls or were embedded. `sourcelink test Microsoft.MacCatalyst.pdb` —> `sourcelink test passed: Microsoft.MacCatalyst.pdb` The PDB size does increase in size after embedding; Microsoft.MacCatalyst.pdb went from 5 MB to 15.7 MB. But considering it would significantly help improve the debugging experience, be consistent with Android’s offerings, and it’s a highlighted attribute on the NuGet package explorer I think it’s a worthy size increase. Refs: xamarin/xamarin-android#7298 dotnet/roslyn#12625 https://github.com/dotnet/sourcelink/tree/main/docs --------- Co-authored-by: Rolf Bjarne Kvinge <rolf@xamarin.com> Co-authored-by: Alex Soto <alex@alexsoto.me> Co-authored-by: Michael Cummings (MSFT) <mcumming@microsoft.com> Co-authored-by: GitHub Actions Autoformatter <github-actions-autoformatter@xamarin.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Android did this: xamarin/xamarin-android#7298
We should implement this as well.
Ref: #11879
As part of this we should make sure the Health tab in the NuGet Package Explorer says we're OK:
from: https://nuget.info/packages/Microsoft.iOS.Runtime.ios-arm64/16.4.8825-net8-rc1
The text was updated successfully, but these errors were encountered: