Skip to content

Commit 03f2b08

Browse files
williamsyang-workbhufmann
authored andcommitted
Update READMEs
Signed-off-by: Will Yang <[email protected]>
1 parent f431d71 commit 03f2b08

File tree

3 files changed

+19
-0
lines changed

3 files changed

+19
-0
lines changed

README.md

+15
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@ yarn playwright test --retries <retries>
235235
[vscode-messages]: https://code.visualstudio.com/api/extension-guides/webview#passing-messages-from-an-extension-to-a-webview
236236
[vscode-webview]: https://github.com/rebornix/vscode-webview-react
237237
[vscode-webview-react]: https://github.com/rebornix/vscode-webview-react
238+
[vscode-ports-tab]: https://raw.githubusercontent.com/eclipse-cdt-cloud/vscode-trace-extension/master/doc/images/vscode-ports-tab-001.png
238239

239240
## Using the External API
240241

@@ -348,3 +349,17 @@ const handleTraceFolders = false;
348349
//The base extension will only provide support for trace files, and not for trace folders
349350
importedApi.setHandleTraceResourceType(handleTraceFiles, handleTraceFolders);
350351
```
352+
353+
### Remote SSH Support
354+
355+
The `Trace Viewer for VSCode` extension is compatible with the use of [remote-ssh](https://code.visualstudio.com/docs/remote/ssh). If you are using `remote-ssh`, you can simply install `Trace Viewer for VSCode` extension on your remote machine and begin using the extension.
356+
357+
The remote support works by forwarding the Trace Server's operating port from the client machine to the remote machine. The port is automatically forwarded on Trace Server startup.
358+
359+
Forwarded ports can be seen in the 'Ports' view of the remote VsCode. To open the `Ports` view use menu `View -> Open view... -> Ports`. You should see the forwarded Trace Server port in the `Ports` view, as shown below:
360+
361+
![ports-tab](vscode-ports-tab)
362+
363+
Make sure that there is no Trace Server running on your local host. If the `Trace Viewer for VSCode` is unresponsive, stop the port forwarding by pressing the 'Stop Port Fowarding (Delete)' of the trace server port and restart remote VSCode.
364+
365+
If you are a developers of the `Trace Viewer for VsCode` and want to modify and test the extension, you can [package it as a VSCode extension (.vsix)](#package-as-a-vscode-extension-vsix), upload the `VSIX` to the remote host and install the extension using the `Install from VSIX...` view menu of the `Extensions` view.

doc/images/vscode-ports-tab-001.png

5.4 KB
Loading

vscode-trace-extension/README.md

+4
Original file line numberDiff line numberDiff line change
@@ -39,3 +39,7 @@ and start it. e.g.:
3939
> ./trace-compass-server-latest-linux.gtk.x86_64/tracecompass-server"
4040
4141
Note: a single trace server can serve multiple traces / clients
42+
43+
## Remote SSH Support
44+
45+
For information about using the extension with `remote-ssh`, please see [Remote SSH Support](https://github.com/eclipse-cdt-cloud/vscode-trace-extension/blob/master/README.md#remote-ssh-support) for the `Trace Viewer for VSCode` extension.

0 commit comments

Comments
 (0)