From 265b31b81db38fdc829457e20278f4df3ee3a23e Mon Sep 17 00:00:00 2001 From: methylDragon Date: Tue, 28 Jun 2022 13:26:50 -0700 Subject: [PATCH] ign -> gz Partial Docs Migration and Project Name Followups : gz-physics (#368) --- Changelog.md | 4 ++-- Migration.md | 10 +++++++++- README.md | 5 ++--- api.md.in | 4 ++-- dartsim/src/SDFFeatures.cc | 2 +- dartsim/src/SDFFeatures_TEST.cc | 2 +- examples/hello_world_loader/CMakeLists.txt | 2 +- examples/hello_world_loader/README.md | 2 +- examples/hello_world_plugin/CMakeLists.txt | 2 +- examples/hello_world_plugin/README.md | 2 +- examples/simple_plugin/CMakeLists.txt | 2 +- tpe/plugin/src/FreeGroupFeatures.cc | 2 +- tutorials.md.in | 4 ++-- tutorials/01_intro.md | 16 +++++++-------- tutorials/02_installation.md | 20 +++++++++---------- tutorials/03_physics_plugins.md | 8 ++++---- tutorials/04-switching-physics-engines.md | 4 ++-- tutorials/05_plugin_loading.md | 4 ++-- tutorials/06-physics-simulation-concepts.md | 17 ++++++++-------- tutorials/07-implementing-a-physics-plugin.md | 4 ++-- tutorials/08-implementing-a-custom-feature.md | 6 +++--- tutorials/09-set-up-physics-engine-tpe.md | 8 ++++---- tutorials/09_use_custom_engine.md | 4 ++-- 23 files changed, 70 insertions(+), 64 deletions(-) diff --git a/Changelog.md b/Changelog.md index acf3c1edc..2043ed575 100644 --- a/Changelog.md +++ b/Changelog.md @@ -180,7 +180,7 @@ * [Pull request #133](https://github.com/gazebosim/gz-physics/pull/133) * [Pull request #116](https://github.com/gazebosim/gz-physics/pull/116) -1. Bump in edifice: ign-common4 +1. Bump in edifice: gz-common4 * [Pull request #205](https://github.com/gazebosim/gz-physics/pull/205) 1. Constructing nested models for dartsim @@ -560,7 +560,7 @@ 1. Add SetJointVelocityCommand feature. * [BitBucket pull request 100](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-physics/pull-requests/100) -1. Add `IGN_PROFILER_ENABLE` cmake option for enabling the ign-common profiler. +1. Add `IGN_PROFILER_ENABLE` cmake option for enabling the gz-common profiler. * [BitBucket pull request 96](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-physics/pull-requests/96) ### Gazebo Physics 1.3.1 (2019-07-19) diff --git a/Migration.md b/Migration.md index 5a6bb2ff2..68fd79fb0 100644 --- a/Migration.md +++ b/Migration.md @@ -7,7 +7,7 @@ release will remove the deprecated code. ## Gazebo Physics 5.X to 6.X -### Deprecation +### Deprecations 1. The `ignition` namespace is deprecated and will be removed in future versions. Use `gz` instead. @@ -27,6 +27,14 @@ release will remove the deprecated code. 1. `IGNITION_UNITTEST_EXPECTDATA_ACCESS` (hard-tocked, inside test and detail headers) 1. `IGNITION_PHYSICS_DEFINE_COORDINATE_SPACE` (hard-tocked, inside detail header) +### Breaking Changes + +* 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__