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

Document profiling.md missmatch with code #109722

Open
loadingcn opened this issue Nov 12, 2024 · 3 comments · May be fixed by #109764
Open

Document profiling.md missmatch with code #109722

loadingcn opened this issue Nov 12, 2024 · 3 comments · May be fixed by #109764
Labels
area-Diagnostics-coreclr documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Milestone

Comments

@loadingcn
Copy link

Cor_Enable_Profiling - only connect with a profiler if this environment variable exists and is set to a non-zero value.
Cor_Profiler - connect with the profiler with this CLSID or ProgID (which must have been stored previously in the Registry). The Cor_Profiler environment variable is defined as a string:
set Cor_Profiler={32E2F4DA-1BEA-47ea-88F9-C5DAF691C94A}, or
set Cor_Profiler="MyProfiler"

These env vars have already been prefixed with CORECLR_:

RETAIL_CONFIG_DWORD_INFO_EX(EXTERNAL_CORECLR_ENABLE_PROFILING, W("CORECLR_ENABLE_PROFILING"), 0, "CoreCLR only: Flag to indicate whether profiling should be enabled for the currently running process.", CLRConfig::LookupOptions::DontPrependPrefix)
RETAIL_CONFIG_STRING_INFO_EX(EXTERNAL_CORECLR_PROFILER, W("CORECLR_PROFILER"), "CoreCLR only: Specifies GUID of profiler to load into currently running process", CLRConfig::LookupOptions::DontPrependPrefix)
RETAIL_CONFIG_STRING_INFO_EX(EXTERNAL_CORECLR_PROFILER_PATH, W("CORECLR_PROFILER_PATH"), "CoreCLR only: Specifies the path to the DLL of profiler to load into currently running process", CLRConfig::LookupOptions::DontPrependPrefix)

Please change them.

@dotnet-policy-service dotnet-policy-service bot added the untriaged New issue has not been triaged by the area owner label Nov 12, 2024
Copy link
Contributor

Tagging subscribers to this area: @tommcdon
See info in area-owners.md if you want to be subscribed.

@tommcdon
Copy link
Member

Hi @loadingcn, thanks for reporting the doc issues in the book of the runtime! Our public docs on https://learn.microsoft.com/en-us/dotnet/core/runtime-config/debugging-profiling seem to be up to date, so I will push this issue to "Future". Please feel free to send us a PR!

@tommcdon tommcdon added this to the Future milestone Nov 12, 2024
@tommcdon tommcdon added documentation Documentation bug or enhancement, does not impact product or test code and removed untriaged New issue has not been triaged by the area owner labels Nov 12, 2024
@loadingcn
Copy link
Author

I see this doc https://learn.microsoft.com/en-us/dotnet/core/runtime-config/debugging-profiling .
As profiling.md is conspicuous in google search result, I think profiling.md is still an important reference for developers.
I'll send a PR in a few days.

loadingcn pushed a commit to loadingcn/runtime that referenced this issue Nov 13, 2024
loadingcn pushed a commit to loadingcn/runtime that referenced this issue Nov 13, 2024
@loadingcn loadingcn linked a pull request Nov 13, 2024 that will close this issue
@dotnet-policy-service dotnet-policy-service bot added the in-pr There is an active PR which will close this issue when it is merged label Nov 13, 2024
loadingcn pushed a commit to loadingcn/runtime that referenced this issue Nov 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-Diagnostics-coreclr documentation Documentation bug or enhancement, does not impact product or test code in-pr There is an active PR which will close this issue when it is merged
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants