From 484c408cfdf44404997190007f2cc7d27b48117f Mon Sep 17 00:00:00 2001 From: methylDragon Date: Tue, 28 Jun 2022 13:27:42 -0700 Subject: [PATCH] ign -> gz Partial Docs Migration and Project Name Followups : gz-sensors (#240) --- Changelog.md | 30 +++++++++++++++--------------- Migration.md | 7 +++++++ README.md | 4 ++-- api.md.in | 4 ++-- examples/save_image/main.cc | 2 +- src/RgbdCameraSensor.cc | 2 +- tutorials.md.in | 4 ++-- tutorials/custom_sensors.md | 13 ++++++------- tutorials/install.md | 24 ++++++++++++------------ tutorials/intro.md | 4 ++-- tutorials/segmentation_camera.md | 10 +++++----- tutorials/thermal_camera.md | 8 ++++---- 12 files changed, 59 insertions(+), 53 deletions(-) diff --git a/Changelog.md b/Changelog.md index 0bead0bb..1873ae7f 100644 --- a/Changelog.md +++ b/Changelog.md @@ -84,7 +84,7 @@ 1. Trivial tutorial typo correction in Custom Sensors tutorial * [Pull request #160](https://github.com/gazebosim/gz-sensors/pull/160) -1. Bumps in fortress: ign-sensors6 +1. Bumps in fortress: gz-sensors6 * [Pull request #120](https://github.com/gazebosim/gz-sensors/pull/120) 1. Port codecov to new configuration @@ -114,7 +114,7 @@ ### Gazebo Sensors 5.1.0 (2021-10-15) -1. Depend on ign-msgs 7.2 and libSDFormat 11.3 +1. Depend on gz-msgs 7.2 and libSDFormat 11.3 * [Pull request #154](https://github.com/gazebosim/gz-sensors/pull/154) 1. 👩‍🌾 Print debug messages when sensors advertise topics @@ -143,16 +143,16 @@ ### Gazebo Sensors 5.0.0 (2021-03-30) -1. Bump in edifice: ign-common4 +1. Bump in edifice: gz-common4 * [Pull request #85](https://github.com/gazebosim/gz-sensors/pull/85) 1. Bump in edifice: sdformat11 * [Pull request #78](https://github.com/gazebosim/gz-sensors/pull/78) -1. Bump in edifice: ign-msgs7 +1. Bump in edifice: gz-msgs7 * [Pull request #75](https://github.com/gazebosim/gz-sensors/pull/75) -1. Bump in edifice: ign-rendering5 +1. Bump in edifice: gz-rendering5 * [Pull request #55](https://github.com/gazebosim/gz-sensors/pull/55) 1. Documentation updates @@ -218,13 +218,13 @@ 1. Move installation instructions from README.md to Installation tutorial * [Pull request 50](https://github.com/gazebosim/gz-sensors/pull/50) -1. Bump ign-math to 6.6 +1. Bump gz-math to 6.6 * [Pull request 48](https://github.com/gazebosim/gz-sensors/pull/48) 1. Replaced common::Time with std::chrono * [Pull request 41](https://github.com/gazebosim/gz-sensors/pull/41) -1. Depend on ign-msgs6, ign-transport9, sdf10 +1. Depend on gz-msgs6, gz-transport9, sdf10 * [Pull request 31](https://github.com/gazebosim/gz-sensors/pull/31) 1. GitHub migration @@ -235,7 +235,7 @@ 1. Set camera sensor visibility mask * [BitBucket pull request 115](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/115) -1. Depend on ign-rendering4 +1. Depend on gz-rendering4 * [BitBucket pull request 111](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/111) ## Gazebo Sensors 3 @@ -309,13 +309,13 @@ 1. Add support for sdformat frame semantics * [BitBucket pull request 104](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/104) -1. Remove deprecations in ign-sensors3 +1. Remove deprecations in gz-sensors3 * [BitBucket pull request 103](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/103) 1. Break out image noise classes * [BitBucket pull request 102](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/102) -1. Depend on ign-transport8, ign-msgs5, sdformat9 +1. Depend on gz-transport8, gz-msgs5, sdformat9 * [BitBucket pull request 101](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/101) * [BitBucket pull request 105](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/105) @@ -328,7 +328,7 @@ 1. Removed deprecations from Manager. * [BitBucket pull request 99](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/99) -1. Depend on ign-rendering3 +1. Depend on gz-rendering3 * [BitBucket pull request 88](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/88) ## Gazebo Sensors 2 @@ -361,7 +361,7 @@ ### Gazebo Sensors 2.6.0 (2019-08-27) -1. Update depth and rgbd camera sensor to output point cloud data generated by ign-rendering DepthCamera +1. Update depth and rgbd camera sensor to output point cloud data generated by gz-rendering DepthCamera * [BitBucket pull request 91](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/91) ### Gazebo Sensors 2.5.1 (2019-08-12) @@ -371,7 +371,7 @@ ### Gazebo Sensors 2.5.0 -1. Add `GZ_PROFILER_ENABLE` cmake option for enabling the ign-common profiler. +1. Add `GZ_PROFILER_ENABLE` cmake option for enabling the gz-common profiler. * [BitBucket pull request 82](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/82) 1. Deduplicate `frame_ids` from sensor message headers @@ -459,10 +459,10 @@ 1. Create component for rendering sensor classes * [BitBucket pull request 42](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/42) -1. Upgrade to ignition-rendering2 +1. Upgrade to gz-rendering2 * [BitBucket pull request 45](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/45) -1. Upgrade to ignition-msgs4 and ignition-transport7 +1. Upgrade to gz-msgs4 and gz-transport7 * [BitBucket pull request 51](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-sensors/pull-requests/51) ### Gazebo Sensors 1.X.X (2019-XX-XX) diff --git a/Migration.md b/Migration.md index bd8c69f9..bfd17021 100644 --- a/Migration.md +++ b/Migration.md @@ -17,6 +17,13 @@ release will remove the deprecated code. 1. **CameraSensor**: the default anti-aliasing value has changed from `2` to `4`. +* 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__