diff --git a/Changelog.md b/Changelog.md index d925a422..c8c00d23 100644 --- a/Changelog.md +++ b/Changelog.md @@ -1,14 +1,23 @@ ## Gazebo Msgs 11.x -### Gazebo Msgs 11.0.0 (2024-08-26) +### Gazebo Msgs 11.0.0 (2024-09-25) + +1. **Baseline:** this includes all changes from 10.3.0 and earlier. + +1. Miscellaneous documentation fixes + * [Pull request #458](https://github.com/gazebosim/gz-msgs/pull/458) + * [Pull request #461](https://github.com/gazebosim/gz-msgs/pull/461) + * [Pull request #459](https://github.com/gazebosim/gz-msgs/pull/459) + * [Pull request #457](https://github.com/gazebosim/gz-msgs/pull/457) + +1. Update gz-msgs11 badge URLs + * [Pull request #455](https://github.com/gazebosim/gz-msgs/pull/455) 1. Improve migration note on SphericalCoordinates * [Pull request #452](https://github.com/gazebosim/gz-msgs/pull/452) - -1. Deprecate LOCAL2 in SphericalCoordinates * [Pull request #451](https://github.com/gazebosim/gz-msgs/pull/451) -1. Backport: Adding cone primitives. +1. Adding cone primitives. * [Pull request #442](https://github.com/gazebosim/gz-msgs/pull/442) 1. Remove cone shape from particle emitter diff --git a/README.md b/README.md index 15e73331..a1af3bf0 100644 --- a/README.md +++ b/README.md @@ -9,44 +9,29 @@ Build | Status -- | -- -Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-msgs/tree/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-msgs/tree/main) -Ubuntu Jammy | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-ci-main-jammy-amd64)](https://build.osrfoundation.org/job/gz_msgs-ci-main-jammy-amd64) -Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/gz_msgs-ci-main-homebrew-amd64) -Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-main-win)](https://build.osrfoundation.org/job/gz_msgs-main-win) +Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-msgs/tree/gz-msgs11/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-msgs/tree/gz-msgs11) +Ubuntu Noble | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-ci-gz-msgs11-noble-amd64)](https://build.osrfoundation.org/job/gz_msgs-ci-gz-msgs11-noble-amd64) +Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-ci-gz-msgs11-homebrew-amd64)](https://build.osrfoundation.org/job/gz_msgs-ci-gz-msgs11-homebrew-amd64) +Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-11-win)](https://build.osrfoundation.org/job/gz_msgs-11-win) Gazebo Messages is a component in the [Gazebo](http://gazebosim.org) framework, a set of libraries designed to rapidly develop robot applications. ## Installation -See the [installation tutorial](https://gazebosim.org/api/msgs/10/install.html). +See the [installation tutorial](https://gazebosim.org/api/msgs/11/install.html). ## Known issue of command line tools 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 -```{.sh} -export GZ_CONFIG_PATH=/usr/local/share/gz +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 ``` - -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. -```{.sh} -mkdir ~/.gz/tools/configs -p -cd ~/.gz/tools/configs/ -ln -s /usr/local/share/gz/fuel8.yaml . -ln -s /usr/local/share/gz/transport14.yaml . -ln -s /usr/local/share/gz/transportlog14.yaml . -... -export GZ_CONFIG_PATH=$HOME/.gz/tools/configs +export GZ_CONFIG_PATH=/usr/local/share/gz:$HOME/ws/install/share/gz ``` -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 diff --git a/tutorials/cppgetstarted.md b/tutorials/cppgetstarted.md index 4bb734a9..d9970fe1 100644 --- a/tutorials/cppgetstarted.md +++ b/tutorials/cppgetstarted.md @@ -60,6 +60,7 @@ To compile the code create a `CMakeLists.txt`: ``` cmake_minimum_required(VERSION 3.22.1 FATAL_ERROR) +project(gz-msgs-example) # Find the Gazebo msgs library find_package(gz-msgs11 QUIET REQUIRED) diff --git a/tutorials/message_generation.md b/tutorials/message_generation.md index 1505e1ce..22820469 100644 --- a/tutorials/message_generation.md +++ b/tutorials/message_generation.md @@ -21,8 +21,7 @@ Gazebo message definitions are stored in the Messages may additionally belong to a `package`, which allows for convenient namespacing or grouping of common messages. Currently, all `gz-msgs` definitions reside in the `gz.msgs` package, which -generates the corresponding `gz::msgs` namespace in C++ and `gz.msgs` in -Python. +generates the corresponding `gz::msgs` namespace in C++ and `gz․msgs` in Python. ### Proto files