From 1bb06f6f18cb4d13cae9e9011a734f1d51799419 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Mon, 27 Jun 2022 16:26:41 -0700 Subject: [PATCH 1/5] Migrate some docs and project names in macros Signed-off-by: methylDragon --- Changelog.md | 2 +- Migration.md | 6 +++--- README.md | 8 ++++---- api.md.in | 4 ++-- conf/msgs.yaml.in | 2 +- src/MessageTypes.hh.in | 2 +- tutorials.md.in | 4 ++-- tutorials/cppgetstarted.md | 8 ++++---- tutorials/install.md | 18 +++++++++--------- 9 files changed, 27 insertions(+), 27 deletions(-) diff --git a/Changelog.md b/Changelog.md index 05b4625f..49672c05 100644 --- a/Changelog.md +++ b/Changelog.md @@ -599,7 +599,7 @@ 1. Added inline versioned namespace. Generator.hh is no longer installed * [BitBucket pull request 59](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-msgs/pull-requests/59) -1. Upgrade to ign-cmake1 +1. Upgrade to gz-cmake1 * [BitBucket pull request 55](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-msgs/pull-requests/55) 1. Extend Factory class diff --git a/Migration.md b/Migration.md index a9fbc2ba..1b144311 100644 --- a/Migration.md +++ b/Migration.md @@ -8,7 +8,7 @@ release will remove the deprecated code. ## Gazebo Msgs 8.X to 9.X 1. **SuppressWarnings.hh** is deprecated and isn't part of `msgs.hh` anymore. - Use ign-utils instead. + Use gz-utils instead. 2. Header files under `ignition/...` are deprecated and will be removed in future versions. Use `gz/...` instead. 3. Protobuf messages and packages will no longer use `ignition.msgs`, use `gz.msgs` instead @@ -137,8 +137,8 @@ release will remove the deprecated code. ### Modifications -1. Use `ignition-math6` instead of `ignition-math5`. - This implies an indirect dependency on `ignition-cmake2` and cmake 3.10.2, +1. Use `gz-math6` instead of `gz-math5`. + This implies an indirect dependency on `gz-cmake2` and cmake 3.10.2, which are not available on Ubuntu Xenial, so migration to Ubuntu Bionic may be required. diff --git a/README.md b/README.md index 2a9b89a7..0001f03e 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_msgs-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_msgs-ci-main-homebrew-amd64) Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=gz_msgs-ci-win)](https://build.osrfoundation.org/job/gz_msgs-ci-win) -Gazebo Messages is a component in the [Ignition](http://gazebosim.org) +Gazebo Messages is a component in the [Gazebo](http://gazebosim.org) framework, a set of libraries designed to rapidly develop robot applications. ## Installation @@ -24,10 +24,10 @@ See the [installation tutorial](https://gazebosim.org/api/msgs/7.0/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 `ign-tools` may not work correctly. +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 Ignition library installation, +`GZ_CONFIG_PATH` to point to the location of the Gazebo library installation, where the YAML file for the package is found, such as ``` export GZ_CONFIG_PATH=/usr/local/share/gz @@ -36,7 +36,7 @@ export GZ_CONFIG_PATH=/usr/local/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 Ignition libraries on the command +Another workaround for working with multiple Gazebo libraries on the command line is using symbolic links to each library's YAML file. ``` mkdir ~/.ignition/tools/configs -p diff --git a/api.md.in b/api.md.in index e73693e3..218f6857 100644 --- a/api.md.in +++ b/api.md.in @@ -1,6 +1,6 @@ -## Ignition @IGN_DESIGNATION_CAP@ +## Gazebo @IGN_DESIGNATION_CAP@ -Ignition @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries +Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries designed to rapidly develop robot and simulation applications. ## License diff --git a/conf/msgs.yaml.in b/conf/msgs.yaml.in index 3bf58fb7..7329d891 100644 --- a/conf/msgs.yaml.in +++ b/conf/msgs.yaml.in @@ -1,4 +1,4 @@ ---- # Subcommands available inside ignition-transport. +--- # Subcommands available inside gz-transport. format: 1.0.0 library_name: @PROJECT_NAME_NO_VERSION_LOWER@ library_version: @PROJECT_VERSION_FULL@ diff --git a/src/MessageTypes.hh.in b/src/MessageTypes.hh.in index d6bd95e3..081746b2 100644 --- a/src/MessageTypes.hh.in +++ b/src/MessageTypes.hh.in @@ -17,7 +17,7 @@ /* This file was automatically generated via CMake. * Do not edit this directly, instead see: - * ign-msgs/src/MessageTypes.hh.in + * gz-msgs/src/MessageTypes.hh.in */ #ifndef GZ_MSGS_MESSAGE_TYPES_HH_ diff --git a/tutorials.md.in b/tutorials.md.in index c8608b49..5fac81b7 100644 --- a/tutorials.md.in +++ b/tutorials.md.in @@ -1,8 +1,8 @@ \page tutorials Tutorials -Welcome to the Ignition @IGN_DESIGNATION_CAP@ tutorials. These tutorials +Welcome to the Gazebo @IGN_DESIGNATION_CAP@ tutorials. These tutorials will guide you through the process of understanding the capabilities of the -Ignition @IGN_DESIGNATION_CAP@ library and how to use the library effectively. +Gazebo @IGN_DESIGNATION_CAP@ library and how to use the library effectively. **The tutorials** diff --git a/tutorials/cppgetstarted.md b/tutorials/cppgetstarted.md index 200ee6a8..4308f027 100644 --- a/tutorials/cppgetstarted.md +++ b/tutorials/cppgetstarted.md @@ -61,11 +61,11 @@ To compile the code create a `CMakeLists.txt`: ``` cmake_minimum_required(VERSION 2.8 FATAL_ERROR) -# Find the Ignition msgs library -find_package(ignition-msgs9 QUIET REQUIRED) +# Find the Gazebo msgs library +find_package(gz-msgs9 QUIET REQUIRED) -add_executable(ignition-msgs-example main.cc) -target_link_libraries(ignition-msgs-example ${GZ-MSGS_LIBRARIES}) +add_executable(gz-msgs-example main.cc) +target_link_libraries(gz-msgs-example ${GZ-MSGS_LIBRARIES}) ``` Let's start by compiling the examples: diff --git a/tutorials/install.md b/tutorials/install.md index 86ab0bc0..88884ec6 100644 --- a/tutorials/install.md +++ b/tutorials/install.md @@ -3,7 +3,7 @@ Next Tutorial: \ref cppgetstarted These instructions are for installing only Gazebo Messages. -If you're interested in using all the Ignition libraries, check out this [Ignition installation](https://gazebosim.org/docs/latest/install). +If you're interested in using all the Gazebo libraries, check out this [Gazebo installation](https://gazebosim.org/docs/latest/install). We recommend following the Binary Installation instructions to get up and running as quickly and painlessly as possible. @@ -13,7 +13,7 @@ The Source Installation instructions should be used if you need the very latest ## Ubuntu -On Ubuntu systems, `apt-get` can be used to install `ignition-msgs`: +On Ubuntu systems, `apt-get` can be used to install `gz-msgs`: ``` sudo apt install libignition-msgs<#>-dev ``` @@ -48,7 +48,7 @@ conda create -n gz-ws conda activate gz-ws ``` -Install `ignition-msgs`: +Install `gz-msgs`: ``` conda install libignition-msgs<#> --channel conda-forge ``` @@ -104,7 +104,7 @@ sudo make uninstall 3. Configure and build ``` - cd ign-msgs + cd gz-msgs mkdir build cd build cmake .. @@ -126,7 +126,7 @@ sudo make uninstall ### Prerequisites -First, follow the [ign-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and creating a Conda environment. +First, follow the [gz-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and creating a Conda environment. Navigate to `condabin` if necessary to use the `conda` command (i.e., if Conda is not in your `PATH` environment variable. You can find the location of `condabin` in Anaconda Prompt, `where conda`). @@ -140,7 +140,7 @@ Install prerequisites: conda install tinyxml2 protobuf --channel conda-forge ``` -Install Ignition dependencies: +Install Gazebo dependencies: You can view lists of dependencies: ``` @@ -164,7 +164,7 @@ This assumes you have created and activated a Conda environment while installing 2. Configure and build ``` - cd ign-msgs + cd gz-msgs mkdir build cd build cmake .. -DBUILD_TESTING=OFF # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install @@ -195,7 +195,7 @@ You can also generate the documentation from a clone of this repository by follo 3. Configure and build the documentation. ``` - cd ign-cmake + cd gz-cmake mkdir build cd build cmake .. @@ -264,4 +264,4 @@ To run test coverage: firefox coverage/index.html ``` -See the [Writing Tests section of the Ignition documentation](https://gazebosim.org/docs/all/contributing#writing-tests) for help creating or modifying tests. +See the [Writing Tests section of the Gazebo documentation](https://gazebosim.org/docs/all/contributing#writing-tests) for help creating or modifying tests. From a950a8a6687f5b5490821222dfdca538d2253b30 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Mon, 27 Jun 2022 16:38:23 -0700 Subject: [PATCH 2/5] Add project name migration note in Migration.md Signed-off-by: methylDragon --- Migration.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/Migration.md b/Migration.md index 1b144311..b539b0aa 100644 --- a/Migration.md +++ b/Migration.md @@ -15,6 +15,15 @@ release will remove the deprecated code. 4. `INSTALL_IGN_MSGS_GEN_EXECUTABLE` and `IGN_MSGS_GEN_EXECUTABLE` are deprecated and will be removed. Use `INSTALL_GZ_MSGS_GEN_EXECUTABLE` and `GZ_MSGS_GEN_EXECUTABLE` instead. 5. `IGN_DESCRIPTOR_PATH` is deprecated and will be removed. Use `GZ_DESCRIPTOR_PATH` instead. +### Breaking Changes + +1. The project name has been changed to use the `gz-` prefix, you **must** use the `gz` prefix! + * This also means that any generated code that use the project name (e.g. CMake variables, in-source macros) would have to be migrated. + * Some non-exhaustive examples of this include: + * `GZ__