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

[docs] Add a note on Native AOT diagnostics support on iOS-like platforms #43399

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

ivanpovazan
Copy link
Member

@ivanpovazan ivanpovazan commented Nov 11, 2024

Summary

This PR adds a note on Native AOT diagnostics support when targeting iOS-like platforms which includes a link to the iOS-specific documentation.


Contributes to: dotnet/runtime#106799


Internal previews

📄 File 🔗 Preview link
docs/core/deploying/native-aot/diagnostics.md Diagnostics and instrumentation

@dotnetrepoman dotnetrepoman bot added this to the November 2024 milestone Nov 11, 2024
@ivanpovazan ivanpovazan changed the title WIP: Add Native AOT diagnostics support documentation for iOS-like platforms [docs] Add Native AOT diagnostics support documentation for iOS-like platforms Nov 11, 2024
@ivanpovazan ivanpovazan marked this pull request as ready for review November 11, 2024 14:23
@ivanpovazan ivanpovazan requested review from tommcdon, a team and adegeo as code owners November 11, 2024 14:23
@jkotas
Copy link
Member

jkotas commented Nov 11, 2024

I have been looking at how existing iOS-specific docs are structured. We seem to have all iOS-specific docs centralized under MAUI.

For example, the iOS-specific docs for dotnet publish are at https://learn.microsoft.com/en-us/dotnet/maui/ios/deployment/publish-cli?view=net-maui-8.0 . They are not next to the generic dotnet publish doc at https://learn.microsoft.com/en-us/dotnet/core/tools/dotnet-publish . Should we follow the existing doc structure and put these docs where all other iOS-specific docs are?

@ivanpovazan ivanpovazan marked this pull request as draft November 12, 2024 11:32
@ivanpovazan ivanpovazan changed the title [docs] Add Native AOT diagnostics support documentation for iOS-like platforms [docs] Add a note on Native AOT diagnostics support on iOS-like platforms Nov 12, 2024
@ivanpovazan
Copy link
Member Author

ivanpovazan commented Nov 12, 2024

@jkotas thank you, I made a note that there is a difference in diagnostics support and added a link to the iOS-specific documentation added to MAUI docs: https://learn.microsoft.com/dotnet/maui/deployment/nativeaot?view=net-maui-9.0&preserve-view=true#native-aot-diagnostic-support-on-ios-and-mac-catalyst

@ivanpovazan ivanpovazan marked this pull request as ready for review November 12, 2024 16:17
@ivanpovazan
Copy link
Member Author

Can we merge this or we need an approval from someone from @dotnet/docs ?
Thanks.

@jkotas
Copy link
Member

jkotas commented Nov 14, 2024

The usual operating procedure is to wait for signoff from the docs team.

@gewarren
Copy link
Contributor

The usual operating procedure is to wait for signoff from the docs team.

I'll take a look today.


## See also

- [Native AOT diagnostic support on iOS and Mac Catalyst](https://learn.microsoft.com/dotnet/maui/deployment/nativeaot?view=net-maui-9.0&preserve-view=true#native-aot-diagnostic-support-on-ios-and-mac-catalyst)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- [Native AOT diagnostic support on iOS and Mac Catalyst](https://learn.microsoft.com/dotnet/maui/deployment/nativeaot?view=net-maui-9.0&preserve-view=true#native-aot-diagnostic-support-on-ios-and-mac-catalyst)
- [Native AOT diagnostic support on iOS and Mac Catalyst](/dotnet/maui/deployment/nativeaot#native-aot-diagnostic-support-on-ios-and-mac-catalyst)

@@ -8,9 +8,9 @@ ms.date: 08/07/2023

# Diagnostics and instrumentation

Native AOT shares some, but not all, diagnostics and instrumentation capabilities with CoreCLR. Because of CoreCLR's rich selection of diagnostic utilities, it's sometimes appropriate to diagnose and debug problems in CoreCLR. Apps that are [trim-compatible](../trimming/prepare-libraries-for-trimming.md) shouldn't have behavioral differences, so investigations often apply to both runtimes. Nonetheless, some information can only be gathered after publishing, so Native AOT also provides post-publish diagnostic tooling.
Native AOT shares some, but not all, diagnostics and instrumentation capabilities with the full .NET runtime. Apps that are [trim-compatible](../trimming/prepare-libraries-for-trimming.md) shouldn't have behavioral differences, so investigations often apply to both runtimes and it's sometimes appropriate to diagnose and debug problems in the full .NET runtime, as it has a rich selection of available diagnostic utilities. Nonetheless, some information can only be gathered after publishing, so Native AOT also provides post-publish diagnostic tooling.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Native AOT shares some, but not all, diagnostics and instrumentation capabilities with the full .NET runtime. Apps that are [trim-compatible](../trimming/prepare-libraries-for-trimming.md) shouldn't have behavioral differences, so investigations often apply to both runtimes and it's sometimes appropriate to diagnose and debug problems in the full .NET runtime, as it has a rich selection of available diagnostic utilities. Nonetheless, some information can only be gathered after publishing, so Native AOT also provides post-publish diagnostic tooling.
Native AOT shares some, but not all, diagnostics and instrumentation capabilities with the full .NET runtime. Apps that are [trim-compatible](../trimming/prepare-libraries-for-trimming.md) shouldn't have behavioral differences, so investigations often apply to both runtimes. As such, it's sometimes appropriate to diagnose and debug problems in the full .NET runtime, as it has a rich selection of available diagnostic utilities. Nonetheless, some information can only be gathered after publishing, so Native AOT also provides post-publish diagnostic tooling.

Copy link
Contributor

Choose a reason for hiding this comment

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

I did this to shorten the sentence length (better for machine translation).

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.

4 participants