You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-3Lines changed: 14 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,9 +1,12 @@
1
1
# VSCode Trace Server extension
2
2
3
-
This is a companion extension to the Trace Viewer for VSCode. It makes it easier to control a default local TSP ([Trace Server Protocol][tsp]) enabled trace server, by providing `Trace Server:` start/stop commands.
3
+
This is a companion extension to the Trace Viewer for VSCode, that helps you manage the life-cycle (starting/stopping) of the trace server, that it needs to analyze and open traces.
4
4
5
-
For development information, please see the developers [README][dev-readme]
5
+
The extension, once [configured](#configuration), can automatically start and stop your trace server for you, letting you enjoy using the Trace Viewer, without having to worry about that aspect. It also registers VSCode `Trace Server:` start/stop commands, that you can invoke as needed.
6
6
7
+
Note: It's assumed you already have a trace server installed locally. If that's not yet the case, please see [here](https://github.com/eclipse-cdt-cloud/vscode-trace-extension/blob/master/vscode-trace-extension/README.md#obtain-the-trace-server-eclipse-trace-compass) for more details about obtaining and installing the Eclipse Trace Compass server.
8
+
9
+
For information about building this extension from source, debugging it, and so on, please see the developer's documentation: [README-dev][dev-readme]
7
10
8
11
## Configuration
9
12
@@ -18,7 +21,15 @@ The following preference settings can be used, under `Trace Server`.
18
21
19
22
### Starting the Trace Server
20
23
21
-
Use the `Trace Server: start (if stopped)` command to launch the trace server instance. The latter should be made of two related processes; `grep` for `tracecompass` or the like.
24
+
Automatic start:
25
+
26
+
If this extension is configured correctly, it will automatically start the trace server, if needed, upon a trace being opened in the trace viewer.
27
+
28
+
Manual start:
29
+
30
+
Use the `Trace Server: start (if stopped)` command to launch the trace server instance. The latter should be made of two related processes; to find them, `grep` for `tracecompass` or the like.
31
+
32
+
Note: this extension is only aware of a running trace server if it started of helped start it, as per above. It will not know if you started the server on the CLI or outside using other means than described above.
0 commit comments