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

.NET 9 RC 1 updates #10395

Merged
merged 6 commits into from
Sep 18, 2024
Merged

.NET 9 RC 1 updates #10395

merged 6 commits into from
Sep 18, 2024

Conversation

gewarren
Copy link
Contributor

@gewarren gewarren commented Sep 12, 2024

First commit - API updates
Second commit - doc updates

Fixes #9989.

apexvss@microsoft.com added 2 commits September 12, 2024 07:19
 Build.Reason:Manual by Genevieve Warren
 Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=456908&view=results
 source_repo.branch:net9-rc1
 source_repo.url:https://apidrop.visualstudio.com/_git/binaries
 Build.Reason:Manual by Genevieve Warren
 Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=456964&view=results
 source_repo.branch:net9-rc1
 source_repo.url:https://apidrop.visualstudio.com/_git/binaries

This comment was marked as outdated.

For more information about using attributes, see [Attributes](/dotnet/standard/attributes/).
]]></format>
</remarks>
Source code imported from
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@huangmin-ms Can you help me figure out where this is coming from? There are no System.Runtime.xml files in the binaries repo under dotnet.

Copy link
Contributor

@huangmin-ms huangmin-ms Sep 13, 2024

Choose a reason for hiding this comment

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

@gewarren
It is coming from Microsoft.Extensions.Diagnostics.ResourceMonitoring.xml of netframework.
Although it is an internal sealed class in this dll. It is a public in mscorlib.dll in the same moniker.

Currently Mdoc will not match the dll file name with the xml file name when importing the related docs.
Not sure why an internal sealed class was documenting in the xml, is it expected?

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@carlossanlop Any idea why the Microsoft.Extensions.Diagnostics.ResourceMonitoring.dll XML doc file would have documentation for System.ObsoleteAttribute?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@huangmin-ms If there is more than one XML doc file for an API, how does mdoc choose which one to use (since docs are shared for all versions/monikers)?

Copy link
Member

Choose a reason for hiding this comment

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

@dotnet/area-system-diagnostics @tarekgh do you folks know where ResourceMonitoring lives? I cannot find it. I wanted to see if it is somehow publishing System.ObsoleteAttribute in its ref.

Copy link
Member

Choose a reason for hiding this comment

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

@carlossanlop It's coming from .NET Framework code.

Sounds more like a question for @HeathAr or someone in her team.

Copy link
Contributor

Choose a reason for hiding this comment

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

@huangmin-ms If there is more than one XML doc file for an API, how does mdoc choose which one to use (since docs are shared for all versions/monikers)?

Firstly, sort alphabetically by moniker name. then sort alphabetically by the the name of the xml.

For example: if one API exits in doc1.xml and doc2.xml of net-9.0 and doc1.xml and doc2.xml of netframework-4.8.1.

It will use doc2.xml in netframework-4.8.1.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@carlossanlop I was mistaken. This is coming from the dotnet/extensions repo. They inject ObsoleteAttribute for down-level frameworks and the .NET Framework XMLs take precedence (which is unfortunate). What to do about this? @evgenyfedorov2

@huangmin-ms In your image in this comment, what folder do you have open? Do I have access to that?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not sure why an internal sealed class was documenting in the xml, is it expected?

Yes, it's expected that csc.exe includes non-public APIs in the documentation XML file. See https://stackoverflow.com/questions/14786930/why-does-c-sharp-compiler-includes-non-public-members-in-the-xml-documentation.

Copy link
Contributor

Choose a reason for hiding this comment

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

@huangmin-ms In your image in this comment, what folder do you have open? Do I have access to that?

Send you instructions via Teams.

This comment was marked as outdated.

This comment was marked as outdated.

Copy link

Learn Build status updates of commit 1ed86ec:

⚠️ Validation status: warnings

File Status Preview URL Details
xml/Microsoft.Extensions.DependencyInjection/AsyncStateExtensions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.DependencyInjection/ResilienceHttpClientBuilderExtensions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HedgingEndpointOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpCircuitBreakerStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpClientHedgingResiliencePredicates.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpClientResiliencePredicates.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpHedgingStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpRateLimiterStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpRetryStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpStandardResilienceOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/HttpTimeoutStrategyOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http.Resilience/ResilienceHandler.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConfigurationConsoleLoggerSettings.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerFormat.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerOptions.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Console/ConsoleLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.Debug/DebugLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.EventLog/EventLogLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.EventLog/EventLogSettings.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.EventSource/EventSourceLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging.TraceSource/TraceSourceLoggerProvider.xml ⚠️Warning View Details
xml/Microsoft.Extensions.Logging/ConsoleLoggerExtensions.xml ⚠️Warning View Details
xml/System.Collections.Generic/CollectionExtensions.xml ⚠️Warning View Details

This comment lists only the first 25 files in the pull request.

xml/Microsoft.Extensions.DependencyInjection/AsyncStateExtensions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.AsyncState.IAsyncLocalContext`1'.

xml/Microsoft.Extensions.DependencyInjection/ResilienceHttpClientBuilderExtensions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.ResiliencePipelineBuilder`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.ResiliencePipelineBuilder`1'.

xml/Microsoft.Extensions.Hosting.Internal/ConsoleLifetime.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Hosting.Internal.ConsoleLifetime.HostOptions'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Hosting.Internal.ConsoleLifetime.HostOptions'.

xml/Microsoft.Extensions.Http.Resilience/HedgingEndpointOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Timeout.TimeoutStrategyOptions.Timeout'.

xml/Microsoft.Extensions.Http.Resilience/HttpCircuitBreakerStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.CircuitBreaker.CircuitBreakerStrategyOptions`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.CircuitBreaker.CircuitBreakerStrategyOptions`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpClientHedgingResiliencePredicates.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpClientResiliencePredicates.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Outcome`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpHedgingStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Hedging.HedgingStrategyOptions`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Hedging.HedgingStrategyOptions`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpRateLimiterStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.RateLimiting.RateLimiterStrategyOptions'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.RateLimiting.RateLimiterStrategyOptions'.

xml/Microsoft.Extensions.Http.Resilience/HttpRetryStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Retry.RetryStrategyOptions`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Retry.RetryStrategyOptions`1'.

xml/Microsoft.Extensions.Http.Resilience/HttpStandardResilienceOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Timeout.TimeoutStrategyOptions.Timeout'.

xml/Microsoft.Extensions.Http.Resilience/HttpTimeoutStrategyOptions.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Timeout.TimeoutStrategyOptions'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.Timeout.TimeoutStrategyOptions'.

xml/Microsoft.Extensions.Http.Resilience/ResilienceHandler.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.ResiliencePipeline`1'.
  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Polly.ResiliencePipeline`1'.

xml/Microsoft.Extensions.Http/IHttpMessageHandlerBuilderFilter.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Http.DefaultHttpClientFactory'.

xml/Microsoft.Extensions.Logging.Console/ConfigurationConsoleLoggerSettings.xml

  • Line 0, Column 0: [Warning: xref-not-found - See documentation] Cross reference not found: 'Microsoft.Extensions.Logging.Console.ConsoleLogger'.

This comment lists only the first 25 errors (including error/warning/suggestion) in the pull request.
For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

@gewarren gewarren merged commit fe3ab19 into dotnet:main Sep 18, 2024
3 checks passed
@gewarren gewarren deleted the net9-rc1-sept12 branch September 18, 2024 21:29
@gewarren gewarren mentioned this pull request Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update API ref for .NET 9 RC 1
3 participants