Skip to content

Commit 9bb618d

Browse files
[dotnet-dsrouter] update docs around $ANDROID_SDK_ROOT (#47567)
Context: https://developer.android.com/tools/variables Context: dotnet/diagnostics#5502 PR #5502 is adding support to "automatically" find the Android SDK as installed by other tools like Visual Studio, Android Studio, etc. `$ANDROID_SDK_ROOT` is also deprecated, so updating any messages to mention `$ANDROID_HOME` instead.
1 parent 143dd66 commit 9bb618d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

docs/core/diagnostics/dotnet-dsrouter.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ dotnet-dsrouter client-server
8989

9090
- **`-fp, --forward-port <forwardPort>`**
9191

92-
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. Make sure to set `ANDROID_SDK_ROOT` before using this option on Android.
92+
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. For Android, optionally set `$ANDROID_HOME` to a valid Android SDK path.
9393

9494
## dotnet-dsrouter server-server
9595

@@ -126,7 +126,7 @@ dotnet-dsrouter server-server
126126

127127
- **`-fp, --forward-port <forwardPort>`**
128128

129-
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. Make sure to set `ANDROID_SDK_ROOT` before using this option on Android.
129+
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. For Android, optionally set `$ANDROID_HOME` to a valid Android SDK path.
130130

131131
## dotnet-dsrouter server-client
132132

@@ -163,7 +163,7 @@ dotnet-dsrouter server-client
163163

164164
- **`-fp, --forward-port <forwardPort>`**
165165

166-
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. Make sure to set `ANDROID_SDK_ROOT` before using this option on Android.
166+
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. For Android, optionally set `$ANDROID_HOME` to a valid Android SDK path.
167167

168168
## dotnet-dsrouter client-client
169169

@@ -200,11 +200,11 @@ dotnet-dsrouter client-client
200200

201201
- **`-fp, --forward-port <forwardPort>`**
202202

203-
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. Make sure to set `ANDROID_SDK_ROOT` before using this option on Android.
203+
Enables port forwarding. The values are `Android` or `iOS` for `TcpClient`, and only `Android` for `TcpServer`. For Android, optionally set `$ANDROID_HOME` to a valid Android SDK path.
204204

205205
## Collect a startup trace using dotnet-trace from a .NET application running on Android
206206

207-
Sometimes it may be useful to collect a trace of an application from its startup. The following steps illustrate the process of doing so targeting a .NET application running on Android. Since `dotnet-dsrouter` is run using port forwarding, the same scenario works against applications running on a local emulator and on a physical device attached over USB. Make sure to set `ANDROID_SDK_ROOT` before using this option or `dotnet-dsrouter` won't be able to find `adb` needed to set up port forwarding.
207+
Sometimes it may be useful to collect a trace of an application from its startup. The following steps illustrate the process of doing so targeting a .NET application running on Android. Since `dotnet-dsrouter` is run using port forwarding, the same scenario works against applications running on a local emulator and on a physical device attached over USB. `dotnet-dsrouter` attempts to automatically locate the Android SDK and `adb` needed to set up port forwarding. Optionally set `$ANDROID_HOME` to specify an Android SDK path.
208208

209209
- Launch dotnet-dsrouter in server-server mode:
210210

0 commit comments

Comments
 (0)