Skip to content

[GUI_tutorial.md] Change --force-version value in Harmonic tutorial to a supported value.#649

Open
mmmarinho wants to merge 2 commits intogazebosim:masterfrom
mmmarinho:patch-1
Open

[GUI_tutorial.md] Change --force-version value in Harmonic tutorial to a supported value.#649
mmmarinho wants to merge 2 commits intogazebosim:masterfrom
mmmarinho:patch-1

Conversation

@mmmarinho
Copy link
Copy Markdown

📜 Documentation Fix

Replace

gz sim --force-version 8.0.0 shapes.sdf

by

gz sim --force-version 8 shapes.sdf

in the harmonic docs.

Summary

The command below, in the harmonic harmonic docs,

gz sim --force-version 8.0.0 shapes.sdf

outputs the following error in modern versions (such as 8.9.0 and 8.10.0)

Version error: I cannot find this command in version [8.0.0]

Checklist

  • Signed all commits for DCO
  • Updated documentation (as needed)

The previous one outputs the error "Version error: I cannot find this command in version [8.0.0]".

Signed-off-by: Murilo M Marinho <46012516+mmmarinho@users.noreply.github.com>
@mmmarinho mmmarinho requested a review from azeey as a code owner November 6, 2025 10:41
@github-actions github-actions Bot added the 🎵 harmonic Gazebo Harmonic label Nov 6, 2025
Copy link
Copy Markdown
Contributor

@azeey azeey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this locally and it seems to work fine for me if you use the versions listed in --versions. So maybe what we need is an explanation that the version can be just the major version number or the exact number listed in --versions.

@github-project-automation github-project-automation Bot moved this from Inbox to In review in Core development Nov 24, 2025
@azeey
Copy link
Copy Markdown
Contributor

azeey commented May 5, 2026

@mmmarinho there hasn't been any activity in a while. Are you planning to get back to this?

@mmmarinho
Copy link
Copy Markdown
Author

Hi @azeey,

How you'd like to go about this? The smallest amount of modifications to make it work for a Harmonic installation would be to modify as I suggested earlier (8.0.0 becomes 8). This is compatible with the text just before it, namely

To ensure you're working with Harmonic, include the --force-version directive when starting up:

gz sim --force-version 8 shapes.sdf

If you want I can add an explanation that it would also work with the full version out of --versions. For instance, in addition to the change above, a note like so.

Note

The version specified to --force-version can be just the major version number or the exact number listed in --versions.

@azeey
Copy link
Copy Markdown
Contributor

azeey commented May 5, 2026

Changing the example to use just the major version number and adding the note sounds good. Thanks!

mmmarinho pushed a commit to mmmarinho/docs that referenced this pull request May 7, 2026
@mmmarinho
Copy link
Copy Markdown
Author

@azeey: Docs seem to be building as we discussed.

Screenshot 2026-05-07 at 13 37 35

@caguero
Copy link
Copy Markdown
Contributor

caguero commented May 7, 2026

Works for me, although it would be nice to change it in the rest of the Gazebo distributions as well (for consistency). E,g,: Fortress, Ionic, etc.

@azeey
Copy link
Copy Markdown
Contributor

azeey commented May 7, 2026

Looks like something was lost. I only see b9b2f90 which doesn't have the Note in the screenshot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

🎵 harmonic Gazebo Harmonic

Projects

Status: In review

Development

Successfully merging this pull request may close these issues.

3 participants