Skip to content

Commit

Permalink
Fix known issue section on README (#275)
Browse files Browse the repository at this point in the history
Signed-off-by: Van Malleghem Antoine <[email protected]>
  • Loading branch information
avanmalleghem authored Sep 4, 2024
1 parent 3599822 commit 14f89d8
Showing 1 changed file with 5 additions and 20 deletions.
25 changes: 5 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,29 +71,14 @@ Sample launch configuration files are in the [examples directory](https://github
In the event that the installation is a mix of Debian and from source, command
line tools from `gz-tools` may not work correctly.

A workaround for a single package is to define the environment variable
`GZ_CONFIG_PATH` to point to the location of the Gazebo library installation,
where the YAML file for the package is found, such as
A workaround is to define the environment variable
`GZ_CONFIG_PATH` to point to the different locations of the Gazebo libraries installations,
where the YAML files for the packages are found, such as
```
export GZ_CONFIG_PATH=/usr/local/share/gz
export GZ_CONFIG_PATH=/usr/local/share/gz:$HOME/ws/install/share/gz
```

However, that environment variable only takes a single path, which means if the
installations from source are in different locations, only one can be specified.

Another workaround for working with multiple Gazebo libraries on the command
line is using symbolic links to each library's YAML file.
```
mkdir ~/.gz/tools/configs -p
cd ~/.gz/tools/configs/
ln -s /usr/local/share/gz/fuel4.yaml .
ln -s /usr/local/share/gz/transport7.yaml .
ln -s /usr/local/share/gz/transportlog7.yaml .
...
export GZ_CONFIG_PATH=$HOME/.gz/tools/configs
```

This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/8).
where `$HOME/ws` is an example colcon workspace used to build Gazebo

# Documentation

Expand Down

0 comments on commit 14f89d8

Please sign in to comment.