aspnetcore: Missing xml documentation for targeting packs

The targeting packs in .NET 5 include the assemblies (.dll files) and documentation (.xml) files. For example, the Microsoft.NETCore.App.Ref targeting pack includes System.Collections.dll as well as System.Collections.xml (the documentation).

$ tar tf dotnet-microsoft-built-sdk-5.0.100-rc.1.20452.10.tar.gz | grep 'Microsoft.NETCore.App.Ref.*System.Collections.[a-z]'
./packs/Microsoft.NETCore.App.Ref/5.0.0-rc.1.20451.14/ref/net5.0/System.Collections.dll
./packs/Microsoft.NETCore.App.Ref/5.0.0-rc.1.20451.14/ref/net5.0/System.Collections.xml

But this information is missing for some packages, such as System.IO.Pipelines

$ tar tf dotnet-microsoft-built-sdk-5.0.100-rc.1.20452.10.tar.gz | grep System.IO.Pipelines
./packs/Microsoft.NETCore.App.Ref/5.0.0-rc.1.20451.14/ref/net5.0/System.IO.Pipelines.dll
./shared/Microsoft.NETCore.App/5.0.0-rc.1.20451.14/System.IO.Pipelines.dll

Originally reported at https://github.com/dotnet/source-build/issues/1686

About this issue

  • Original URL
  • State: closed
  • Created 4 years ago
  • Reactions: 1
  • Comments: 15 (15 by maintainers)

Most upvoted comments

@ericstj I didn’t check the other packages. Thanks. So, System.IO.Pipelines is a separate case that’ll require a dotnet/runtime fix to enable the scenario to be patched up.

The larger issue is: We never had the correct msbuild gobbledygook to get the XML files from the packages where we get “loose” ref/ assemblies. But, we can add that code in a generic way (I hope) and pick up the documentation from all ~12 packages we reference. Shouldn’t be too difficult since we include their ref/ assemblies in Microsoft.AspNetCore.App.Ref and the XML files will (soon) all sit beside those assemblies.

@dagood back-porting the fix to 3.1 for #26068 shouldn’t be horrendous.

Yes, it moved back to AspNetCore.App after RC1.

@dotnet/aspnet-build can someone take a look?