-
Notifications
You must be signed in to change notification settings - Fork 6k
Document Diagnostic Port #29007
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 Diagnostic Port #29007
Conversation
Fixes dotnet/diagnostics#2900 We added the diagnostic port in 3.1 and expanded on it in 5.0, but never documented it aside from tangential references in some tools that used it. This change describes it directly and adds some detail that wasn't mentioned elsewhere. I also tried to improve docs on some related environment variables that misleadingly claimed scenarios were only for dotnet-monitor or only for Mono.
I'm still need to clean up the lint stuff and build warnings, but it should be close enough to do a decent review |
Thanks @lateralusX 👍 I think I had a little tunnel vision associating Mono with Android/iOS/tvOS. I pivoted the description to focus on the operating system and hopefully I've got Mono included in all the right places now. |
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.
Looks good, just some grammar and style suggestions.
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.
LGTM sans a couple nits I commented on 👍
Co-authored-by: Tom Dykstra <tdykstra@microsoft.com> Co-authored-by: John Salem <josalem@microsoft.com>
877cad6
to
58d25ac
Compare
Thanks all! |
@josalem - got it and yeah I can see the confusion. I'm going to guess that even if people are confused and thought diagnostic port was used to implement debugging they would still conclude that debugging is effected. If you have any thoughts on a better way to say it we could always do a tiny PR that adjusts it : ) Thanks! |
* Document Diagnostic Port Fixes dotnet/diagnostics#2900 We added the diagnostic port in 3.1 and expanded on it in 5.0, but never documented it aside from tangential references in some tools that used it. This change describes it directly and adds some detail that wasn't mentioned elsewhere. I also tried to improve docs on some related environment variables that misleadingly claimed scenarios were only for dotnet-monitor or only for Mono. * Apply suggestions from code review Co-authored-by: Tom Dykstra <tdykstra@microsoft.com> Co-authored-by: John Salem <josalem@microsoft.com>
Fixes dotnet/diagnostics#2900
We added the diagnostic port in 3.1 and expanded on it in 5.0, but never
documented it aside from tangential references in some tools that used it.
This change describes it directly and adds some detail that wasn't mentioned
elsewhere. I also tried to improve docs on some related environment variables
that misleadingly claimed scenarios were only for dotnet-monitor or only for
Mono.