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
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`.
Copy file name to clipboardExpand all lines: source/How-To-Guides/Use-The-Dashboard.rst
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Prerequisites
20
20
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>`_.
21
21
22
22
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.
24
24
25
25
26
26
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