Missing xml docs for some dlls #1686
Comments
|
Hmm. This library is created by CoreFX as a platform extension not in the netcoreapp shared framework, then ASP.NET Core is bringing it into its own shared framework. I believe the DLL is present in the ASP.NET Core targeting pack because users need/want to compile against the version of the library in the shared framework. Based on that, I would expect the XML files to be included in the targeting pack... this lets people using these refs get at the docs without setting up a redundant System.IO.Pipelines package reference. (Although I don't actually know if setting that up would get the docs working end-to-end. I'm not really familiar with how they get picked up, but I think they have to be adjacent to the DLL that'll be used to compile, and maybe the targeting pack one would take precedence and prevent discovery.) https://www.nuget.org/packages/System.IO.Pipelines/4.7.2 looks like it has the XML, I would guess the redist logic just isn't set up to include it. I think this is an issue in https://github.com/dotnet/aspnetcore, and if it's fixed there, we'll semi-automatically get a fix in source-build when we generate the new targeting pack in source-build-reference-packages. (Whether it's fixed in 5.0, 3.1, or both.) Do you mind reporting this as a bug there? The most direct assets to examine and point at are probably these because there's no potential for error in the SDK packing infra: |
dseefeld
added
area-build
|
Sorry, I dropped the ball on this issue. Revisiting the issue now, I see things are missing even in Microsoft.NETCore.App: What reproduce produces this? dotnet/sdk? |
This is most likely just a symptom of the targeting pack being built in the repo rather than dotnet/source-build-reference-packages. A regression of #1578. I don't think we've run the release checklist on a 5.0 build yet, which has a step to catch this. The original issue is about some XML files that don't show up in the Microsoft or source-build targeting pack, which is a separate issue that I think should be reported to https://github.com/dotnet/aspnetcore. |
|
Ah, the source-build side of the 5.0 issue is actually tracked at #1703. Thanks for filing https://github.com/dotnet/runtime/issues/42459 for the dotnet/runtime side of the 5.0 issue. There's still a potential bug with 3.1: https://www.nuget.org/packages/Microsoft.AspNetCore.App.Ref/3.1.8 still doesn't have a I don't think there's anything extra that this issue is tracking at this point--closing. |
|
Thanks for filing dotnet/aspnetcore#26068. I didn't realize that things need to be fixed in multiple places. |
I am looking through my .NET Core build and trying to make sure that we have xml documentation for targeting packs. I see a number of
.dllfiles have no corresponding.xmlfiles. I am not sure if I am doing something wrong or if the documentation is actually missing:There is no
.xmlfile forSystem.IO.Pipelines.dll. Is that expected?I looked at the Microsoft tarball, and it has the same issue:
Here's my test script:
This is the complete output
The text was updated successfully, but these errors were encountered: