Skip to content

Commit

Permalink
README files: Fix the markdownlint IDE warnings
Browse files Browse the repository at this point in the history
Fix the markdownlint issues reported through VS Code/Codium for the
README files:

- MD046: Code block style [Expected: indented; Actual: fenced]
- MD051: Link fragments should be valid

Fix any direct typo while in these.

Change-Id: I7ee24920b09c81a43fa8ac5fc69797c182f58f7e
Signed-off-by: Marco Miller <marco.miller@ericsson.com>
Reviewed-on: https://git.eclipse.org/r/c/tracecompass.incubator/org.eclipse.tracecompass.incubator/+/200961
Tested-by: Trace Compass Bot <tracecompass-bot@eclipse.org>
Tested-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
Reviewed-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
  • Loading branch information
marco-miller committed Mar 31, 2023
1 parent 9a19195 commit c510f64
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ For information on running the Trace Compass Trace Server, refer to the [README]

## Project rules and guidelines

This project is an incubator which aims at rapid availability of new features and prototypes, to provide new functionnalities to end users and get feedback from them during the development process. As such, code style and design architecture will not be looked at too much during reviews, though some advices and ideas can be discussed. The features have to work as expected though and not break anything in Trace Compass.
This project is an incubator which aims at rapid availability of new features and prototypes, to provide new functionalities to end users and get feedback from them during the development process. As such, code style and design architecture will not be looked at too much during reviews, though some advices and ideas can be discussed. The features have to work as expected though and not break anything in Trace Compass.

- Add unit tests: CI will be run on every patch on gerrit, so having unit tests ensures that a patch does not break anything somewhere else. Also, these plugins are work in progress. Having unit tests makes it easier to manipulate code structure and algorithms by knowing the expected results. Tests need to be maintained, but have more benefits than trouble.

Expand Down
22 changes: 9 additions & 13 deletions trace-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

- [Compiling manually](#compiling-manually)
- [Running the server](#running-the-server)
- [Run the Server with SSL](#run-the-server-with-ssl)
- [Run the Server with SSL](#running-the-server-with-ssl)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

Expand All @@ -17,7 +17,7 @@ The Maven project build requires version 3.3 or later. It can be downloaded from
<http://maven.apache.org> or from the package management system of your distro.

To build the trace-server manually using Maven, simply run the following command
from the git progect top-level directory:
from the git project top-level directory:

cd org.eclipse.tracecompass.incubator/
mvn clean install
Expand All @@ -36,10 +36,8 @@ contain the executable for each OS.

## Running the server

```shell
cd trace-server/org.eclipse.tracecompass.incubator.trace.server.product/target/products/traceserver/linux/gtk/x86_64/trace-compass-server/
./tracecompass-server`
```
cd trace-server/org.eclipse.tracecompass.incubator.trace.server.product/target/products/traceserver/linux/gtk/x86_64/trace-compass-server/
./tracecompass-server

This server is an implementation of the [Trace Server Protocol](https://github.com/theia-ide/trace-server-protocol),
whose [API is documented](https://theia-ide.github.io/trace-server-protocol/) using the OpenAPI REST specification.
Expand All @@ -59,13 +57,11 @@ Follow the instructions to [configure SSL on jetty](https://www.eclipse.org/jett
Then, you can edit the `tracecompass-server.ini` file to pass the keystore data and SSL port as parameters after the `-vmargs` line.
For example, here is an excerpt of the file:

```shell
[...]
-vmargs
[...]
-Dtraceserver.port=8443
-Dtraceserver.keystore=/path/to/keystore
```
[...]
-vmargs
[...]
-Dtraceserver.port=8443
-Dtraceserver.keystore=/path/to/keystore

The following properties are supported:

Expand Down

0 comments on commit c510f64

Please sign in to comment.