Skip to content

Commit 876704f

Browse files
Fix syntax of argument to cmake (#26).
The page describing how to use the dashboard states that colcon build has to be called with arguments `--cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS`, which is not valid syntax because variables have to be given a value. This commit modifies that sentence to indicate that the value should be `ON`.
1 parent be70179 commit 876704f

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

source/How-To-Guides/Use-The-Dashboard.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Prerequisites
2020
In order to use the Space ROS Dashboard, you will have to install `Visual Studio Code <https://code.visualstudio.com/>`_ and the `Space ROS Dashboard extension <https://marketplace.visualstudio.com/items?itemName=openrobotics.spaceros-dashboard>`_.
2121

2222
You will also need to have SARIF data to view, which you can obtain through running `colcon build` and then `colcon test`.
23-
Note, that you will have to enable exporting of the compile commands, which you can do by running `colcon build` with `--cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS` or by adding `set(COLCON_EXPORT_COMPILE_COMMANDS ON)` in the package's `CMakeLists.txt` file.
23+
Note, that you will have to enable exporting of the compile commands, which you can do by running `colcon build` with `--cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON` or by adding `set(COLCON_EXPORT_COMPILE_COMMANDS ON)` in the package's `CMakeLists.txt` file.
2424

2525

2626
Optionally, you can use `Microsoft's Dev Containers Extension <https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers>`_ to use the Space ROS Dashboard with Visual Studio Code inside of a Docker container.

0 commit comments

Comments
 (0)