Update diagnostics IPC protocol doc (#1814)
authorSung Yoon Whang <suwhang@microsoft.com>
Thu, 10 Dec 2020 22:11:10 +0000 (14:11 -0800)
committerGitHub <noreply@github.com>
Thu, 10 Dec 2020 22:11:10 +0000 (14:11 -0800)
* fix broken links, remove reference to outdated terms

* Update documentation/design-docs/ipc-protocol.md

Co-authored-by: John Salem <josalem@microsoft.com>
Co-authored-by: John Salem <josalem@microsoft.com>
documentation/design-docs/ipc-protocol.md

index c2f635b4345e4540d0f7f6bdae3706bc4c3403fb..d5238a007182e8ff915a370377d37dda0f93a1c4 100644 (file)
@@ -731,7 +731,7 @@ struct Payload
 
 Command Code: `0x0401`
 
-If the target .NET application has been configured with `DOTNET_DiagnosticsMonitorAddress` and `DOTNET_DiagnosticsMonitorPauseOnStart` has not been set to `0`, then the runtime will pause during `EEStartupHelper` in `ceemain.cpp` and wait for an event to be set.  (See [Reverse Diagnostics Server](#Reverse-Diagnostics-Server) for more details)
+If the target .NET application has been configured Diagnostic Ports configured to suspend with `DOTNET_DiagnosticPorts` or `DOTNET_DefaultDiagnosticPortSuspend` has been set to `1` (`0` is the default value), then the runtime will pause during `EEStartupHelper` in `ceemain.cpp` and wait for an event to be set.  (See [Diagnostic Ports](#diagnostic-ports) for more details)
 
 The `ResumeRuntime` command sets the necessary event to resume runtime startup.  If the .NET application _has not_ been configured to with Diagnostics Monitor Address or the runtime has _already_ been resumed, this command is a no-op.
 
@@ -970,7 +970,7 @@ This is a one-way transmission with no expectation of an ACK.  The tool owning t
 
 ## Dataflow
 
-Due to the potential for an *optional continuation* in the Diagnostics IPC Protocol, each successful connection between the runtime and a Diagnostic Port is only usable **once**.  As a result, a .NET process will attempt to _reconnect_ to the Reverse Server immediately after every command that is sent across an active connection.
+Due to the potential for an *optional continuation* in the Diagnostics IPC Protocol, each successful connection between the runtime and a Diagnostic Port is only usable **once**.  As a result, a .NET process will attempt to _reconnect_ to the diagnostic port immediately after every command that is sent across an active connection.
 
 A typical dataflow has 2 actors, the Target application, `T` and the Diagnostics Monitor Application, `M`, and communicates like so:
 ```