Skip to content
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.

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

3.1 is missing xml docs for Microsoft.NETCore.App #1578

Closed
omajid opened this issue May 7, 2020 · 6 comments
Closed

3.1 is missing xml docs for Microsoft.NETCore.App #1578

omajid opened this issue May 7, 2020 · 6 comments
Assignees
Labels
area-infra Source-build infrastructure and reporting

Comments

@omajid
Copy link
Member

omajid commented May 7, 2020

The SDK created by source-build is missing xml docs for Microsoft.NETCore.App targeting pack. The xml docs are available for Microsoft.AspNetCore.App targeting pack, though. Without these docs, users get incomplete documentation via IntelliSense for types and members.

 /usr/lib64/dotnet/dotnet --info
.NET Core SDK (reflecting any global.json):
 Version:   3.1.103
 Commit:    6f74c4a1dd

Runtime Environment:
 OS Name:     fedora
 OS Version:  32
 OS Platform: Linux
 RID:         fedora.32-x64
 Base Path:   /usr/lib64/dotnet/sdk/3.1.103/

Host (useful for support):
  Version: 3.1.3
  Commit:  4a9f85e9f8

.NET Core SDKs installed:
  3.1.103 [/usr/lib64/dotnet/sdk]

.NET Core runtimes installed:
  Microsoft.AspNetCore.App 3.1.3 [/usr/lib64/dotnet/shared/Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 3.1.3 [/usr/lib64/dotnet/shared/Microsoft.NETCore.App]

To install additional .NET Core runtimes or SDKs:
  https://aka.ms/dotnet-download

$ find /usr/lib64/dotnet/packs/Microsoft.NETCore.App.Ref/ -iname '*.xml'
/usr/lib64/dotnet/packs/Microsoft.NETCore.App.Ref/3.1.0/data/FrameworkList.xml
$ find /usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/ -iname '*.xml' | head
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/data/FrameworkList.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.AspNetCore.Routing.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.Extensions.Configuration.UserSecrets.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.AspNetCore.WebSockets.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.Extensions.ObjectPool.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.Extensions.Localization.Abstractions.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.AspNetCore.Mvc.ApiExplorer.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.AspNetCore.ResponseCaching.Abstractions.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.Extensions.Logging.EventSource.xml
/usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/3.1.3/ref/netcoreapp3.1/Microsoft.Net.Http.Headers.xml
$ find /usr/lib64/dotnet/packs/Microsoft.AspNetCore.App.Ref/ -iname '*.xml' | wc -l
123

In a non-source-build SDK:

$ ./dotnet --info
.NET Core SDK (reflecting any global.json):
 Version:   3.1.101
 Commit:    b377529961

Runtime Environment:
 OS Name:     fedora
 OS Version:  32
 OS Platform: Linux
 RID:         fedora.32-x64
 Base Path:   /home/omajid/local/dotnet-sdk-3.1.101/sdk/3.1.101/

Host (useful for support):
  Version: 3.1.1
  Commit:  a1388f194c

.NET Core SDKs installed:
  3.1.101 [/home/omajid/local/dotnet-sdk-3.1.101/sdk]

.NET Core runtimes installed:
  Microsoft.AspNetCore.App 3.1.1 [/home/omajid/local/dotnet-sdk-3.1.101/shared/Microsoft.AspNetCore.App]
  Microsoft.NETCore.App 3.1.1 [/home/omajid/local/dotnet-sdk-3.1.101/shared/Microsoft.NETCore.App]

To install additional .NET Core runtimes or SDKs:
  https://aka.ms/dotnet-download
$ find packs/Microsoft.NETCore.App.Ref/ -name '*.xml' | wc -l
112

Originally reported at https://bugzilla.redhat.com/show_bug.cgi?id=1831310

cc @tmds @RheaAyase

@dagood
Copy link
Member

dagood commented May 7, 2020

Hmm... I'd expect to find Microsoft.NETCore.App.Ref 3.1.0 in https://github.com/dotnet/source-build-reference-packages/tree/master/src/targetPacks/ILsrc/microsoft.netcore.app.ref to explain/fix this, but I only see 3.0.0 there. @dseefeld @crummel ideas?

@dagood
Copy link
Member

dagood commented May 7, 2020

Related, we have to be careful not to build the targeting packs in dotnet/core-setup at the moment, although for a different reason #1523:

We also need to be careful not to build targeting packs from source (dotnet/runtime#32982), since they may have incomplete platform manifests: dotnet/runtime#1622.

Maybe this an extra symptom?

@dseefeld dseefeld added area-infra Source-build infrastructure and reporting area-release Release tasks or related issues triaged and removed area-release Release tasks or related issues labels May 7, 2020
@dseefeld
Copy link
Contributor

dseefeld commented May 7, 2020

@crummel will add testing for xml files and checking the manifest to the release checklist.
@crummel to look at automated testing for this.

  • these will be split out into another issue.

@dseefeld will add Microsoft.NETCore.App.Ref 3.1.0 to sbrp - This is the fix for this issue.

@crummel
Copy link
Contributor

crummel commented May 7, 2020

Created #1579 for the testing.

@omajid
Copy link
Member Author

omajid commented Jun 18, 2020

I think we can close this issue now?

@crummel
Copy link
Contributor

crummel commented Jun 18, 2020

Yes, agreed, thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-infra Source-build infrastructure and reporting
Projects
None yet
Development

No branches or pull requests

4 participants