Skip to content

Commit 46ebcc9

Browse files
Update for review comments
Signed-off-by: Marc Dumais <marc.dumais@ericsson.com>
1 parent f183ad3 commit 46ebcc9

2 files changed

Lines changed: 15 additions & 7 deletions

File tree

README-dev.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# VSCode Trace Server extension
22

3-
This file contains information that could be interesting to developers, that want to mnodify, build, test, and debug this extension.
3+
This file contains information that could be interesting to developers, that want to modify, build, test, and debug this extension.
44

55
For general information, see the main [README.md](README.md)
66

@@ -81,9 +81,6 @@ yarn format:write
8181

8282
```
8383

84-
## Status
85-
86-
This extension is currently under [initial development][backlog].
8784

8885
[backlog]: https://github.com/eclipse-cdt-cloud/vscode-trace-extension/issues/15
8986
[blueprint]: https://theia-ide.org/docs/blueprint_download

README.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# VSCode Trace Server extension
22

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.
44

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.
66

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]
710

811
## Configuration
912

@@ -18,7 +21,15 @@ The following preference settings can be used, under `Trace Server`.
1821

1922
### Starting the Trace Server
2023

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.
2233

2334
### Stopping the Trace Server
2435

0 commit comments

Comments
 (0)