Skip to content

Commit

Permalink
Fix syntax of argument to cmake (#26).
Browse files Browse the repository at this point in the history
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`.
  • Loading branch information
ivanperez-keera committed Jan 11, 2024
1 parent be70179 commit 876704f
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion source/How-To-Guides/Use-The-Dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Prerequisites
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>`_.

You will also need to have SARIF data to view, which you can obtain through running `colcon build` and then `colcon test`.
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.
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.


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.
Expand Down

0 comments on commit 876704f

Please sign in to comment.