Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor error in Use-The-Dashboard.rst #26

Closed
ivanperez-keera opened this issue Jan 11, 2024 · 0 comments · Fixed by #27
Closed

Minor error in Use-The-Dashboard.rst #26

ivanperez-keera opened this issue Jan 11, 2024 · 0 comments · Fixed by #27
Assignees
@ivanperez-keera
Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed
Milestone
humble-2024.01.0

Comments

@ivanperez-keera
Copy link
Contributor

ivanperez-keera commented Jan 11, 2024 •
edited
Loading

The page describing how to use the dashboard states that colcon build has to be called with arguments:

--cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS

This is not valid syntax. It should be:

--cmake-args -DCMAKE_EXPORT_COMPILE_COMMANDS=ON

Offending line:
https://github.com/space-ros/docs/blob/dd8cff49220293c16884ba25b776b7db2f8cecc2/source/How-To-Guides/Use-The-Dashboard.rst?plain=1#L23C27-L23C27
@ivanperez-keera ivanperez-keera added bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed labels Jan 11, 2024
@ivanperez-keera ivanperez-keera changed the title Minor error in Use-The-Dashboard.html Minor error in Use-The-Dashboard.rst Jan 11, 2024
@ivanperez-keera ivanperez-keera added this to the humble-2024.01.0 milestone Jan 11, 2024
@ivanperez-keera ivanperez-keera self-assigned this Jan 11, 2024
ivanperez-keera added a commit that referenced this issue Jan 11, 2024
@ivanperez-keera
Fix syntax of argument to cmake (#26).
a9f90c1 
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`.
ivanperez-keera added a commit that referenced this issue Jan 11, 2024
@ivanperez-keera
Fix syntax of argument to cmake (#26).
876704f 
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`.
@Bckempa Bckempa linked a pull request Jan 11, 2024 that will close this issue
Fix syntax of argument to cmake (#26). #27
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ivanperez-keera ivanperez-keera

Labels
bug Something isn't working good first issue Good for newcomers help wanted Extra attention is needed
Projects
Space ROS Project Development
Status: Done
Milestone
humble-2024.01.0
Development

Successfully merging a pull request may close this issue.

Fix syntax of argument to cmake (#26). space-ros/docs
1 participant
@ivanperez-keera