From 876704fe1e2b36de2db2758c81f8c60010f5fcda Mon Sep 17 00:00:00 2001 From: Ivan Perez Date: Thu, 11 Jan 2024 05:36:50 -0800 Subject: [PATCH] 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`. --- source/How-To-Guides/Use-The-Dashboard.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/How-To-Guides/Use-The-Dashboard.rst b/source/How-To-Guides/Use-The-Dashboard.rst index 731a0ff..4343f32 100644 --- a/source/How-To-Guides/Use-The-Dashboard.rst +++ b/source/How-To-Guides/Use-The-Dashboard.rst @@ -20,7 +20,7 @@ Prerequisites In order to use the Space ROS Dashboard, you will have to install `Visual Studio Code `_ and the `Space ROS Dashboard extension `_. 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 `_ to use the Space ROS Dashboard with Visual Studio Code inside of a Docker container.