-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Update doc on profiling config settings #49964
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
base: main
Are you sure you want to change the base?
Conversation
noahfalk
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
| @@ -0,0 +1,2 @@ | |||
| > [!NOTE] | |||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if the doc team has any preference here, but if we are only including this text in one place it may be simpler to inline it there rather than using the include mechanism. The DOTNET version of this got included from many different pages.
Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
Co-authored-by: Noah Falk <noahfalk@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR updates the documentation for profiling configuration settings in .NET. The changes document the new DOTNET_* prefix support for profiler environment variables introduced in .NET 11, alongside the existing CORECLR_* prefixes maintained for backward compatibility.
Key changes include:
- Adding a new include file explaining the dual prefix support for profiler environment variables starting in .NET 11
- Documenting new ARM32 and ARM64 profiler path environment variables
- Reorganizing the profiler location section to clarify the two loading methods (environment variables and Windows registry)
- Expanding documentation on Windows registry-based profiler loading
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| includes/coreclr-prefix.md | New include file explaining DOTNET and CORECLR prefix support starting in .NET 11 |
| docs/core/runtime-config/debugging-profiling.md | Updated environment variable tables to show both CORECLR_* and DOTNET_* prefixes, added ARM32/ARM64 paths, added registry loading documentation, and reorganized profiler location section |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Summary
Move documentation from https://github.com/dotnet/runtime/blob/main/docs/design/coreclr/profiling/Profiler%20Loading.md to https://github.com/dotnet/docs/blob/main/docs/core/runtime-config/debugging-profiling.md
Add description of changes introduced after merging dotnet/runtime#121646, issue: dotnet/runtime#117902
Fixes #49963
Internal previews