From 77b64dd47ab20d83979e6a99a5a6c502f8896282 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Mon, 27 Jun 2022 16:26:44 -0700 Subject: [PATCH 1/3] Migrate some docs and project names in macros Signed-off-by: methylDragon --- CMakeLists.txt | 2 +- Changelog.md | 2 +- Migration.md | 6 +++--- README.md | 10 +++++----- api.md.in | 4 ++-- tutorials.md.in | 4 ++-- tutorials/installation.md | 4 ++-- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/CMakeLists.txt b/CMakeLists.txt index 6c733a0..ac20c76 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR) project(gz-utils2 VERSION 2.0.0) #============================================================================ -# Find ignition-cmake +# Find gz-cmake #============================================================================ # If you get an error at this line, you need to install ignition-cmake find_package(gz-cmake3 REQUIRED) diff --git a/Changelog.md b/Changelog.md index 2893305..5a8ed89 100644 --- a/Changelog.md +++ b/Changelog.md @@ -26,7 +26,7 @@ 1. Fix inline namespace issue with clang6 * [Pull request #39](https://github.com/gazebosim/gz-utils/pull/39) -1. Move ExtraTestMacros from ign-cmake +1. Move ExtraTestMacros from gz-cmake * [Pull request #37](https://github.com/gazebosim/gz-utils/pull/37) ## Gazebo Utils 1.2.0 (2022-01-28) diff --git a/Migration.md b/Migration.md index 4f372f5..0318217 100644 --- a/Migration.md +++ b/Migration.md @@ -31,9 +31,9 @@ release will remove the deprecated code. ## Gazebo Utils 1.2 to 1.3 Recommended migration: -Utils 1.3.0 introduces the `ExtraTestMacros.hh` headers that are also in ign-cmake. -This is an effort to remove all headers from ign-cmake and locate them in ign-utils. +Utils 1.3.0 introduces the `ExtraTestMacros.hh` headers that are also in gz-cmake. +This is an effort to remove all headers from gz-cmake and locate them in gz-utils. To update, replace all instances of `ignition/utilities/ExtraTestMacros.hh` with `ignition/utils/ExtraTestMacros.hh` -In the future, `ignition/utilities/ExtraTestMacros.hh` will be removed from ign-cmake. +In the future, `ignition/utilities/ExtraTestMacros.hh` will be removed from gz-cmake. ## Gazebo Utils 0.X to 1.X diff --git a/README.md b/README.md index 4836004..787101c 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_utils-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_utils-ci-main-homebrew-amd64) Windows | [![Build Status](https://build.osrfoundation.org/job/ign_utils-ci-win/badge/icon)](https://build.osrfoundation.org/job/ign_utils-ci-win/) -Gazebo Utils, a component of [Ignition +Gazebo Utils, a component of [Gazebo Robotics](https://gazebosim.org), provides general purpose classes and functions designed for robotic applications. @@ -77,7 +77,7 @@ You can also generate the documentation from a clone of this repository by follo 3. Configure and build the documentation. ``` - cd ign-utils; mkdir build; cd build; cmake ../; make doc + cd gz-utils; mkdir build; cd build; cmake ../; make doc ``` 4. View the documentation by running the following command from the build directory. @@ -109,7 +109,7 @@ Follow these steps to run tests and static code analysis in your clone of this r Refer to the following table for information about important directories and files in this repository. ``` -ign-utils +gz-utils ├── examples Example programs. ├── include/ignition/utils Header files. ├── src Source files and unit tests. @@ -135,9 +135,9 @@ Please see This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the -[Ignition project](https://gazebosim.org) which periodically +[Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the -[Ignition website](https://gazebosim.org) for version and +[Gazebo website](https://gazebosim.org) for version and release information. # License diff --git a/api.md.in b/api.md.in index a85d2ea..c3aefe2 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 +Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries designed to rapidly develop robot and simulation applications. This library defines a general set of utilities with an eye toward simulation and robotics. diff --git a/tutorials.md.in b/tutorials.md.in index 7a404d4..30fa3cf 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/installation.md b/tutorials/installation.md index 499aa47..d439844 100644 --- a/tutorials/installation.md +++ b/tutorials/installation.md @@ -61,7 +61,7 @@ necessary prerequisites followed by building from source. 2. Clone the repository ``` - git clone https://github.com/gazebosim/gz-utils -b ign-utils<#> + git clone https://github.com/gazebosim/gz-utils -b gz-utils<#> ``` Be sure to replace `<#>` with a number value, such as 1 or 2, depending on which version you need. @@ -76,7 +76,7 @@ necessary prerequisites followed by building from source. 4. Configure and build ``` - cd ign-utils; mkdir build; cd build; cmake ..; make + cd gz-utils; mkdir build; cd build; cmake ..; make ``` 5. Optionally, install Gazebo Utils From 7905bd6b0100ad99a6029c39d1cc965c1dcf2404 Mon Sep 17 00:00:00 2001 From: methylDragon Date: Mon, 27 Jun 2022 16:38:26 -0700 Subject: [PATCH 2/3] Add project name migration note in Migration.md Signed-off-by: methylDragon --- Migration.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Migration.md b/Migration.md index 0318217..b7d323d 100644 --- a/Migration.md +++ b/Migration.md @@ -23,10 +23,16 @@ release will remove the deprecated code. * `IGN_UTILS_UNIQUE_IMPL_PTR_FWD` * `IGN_UTILS_IMPL_PTR` * `IGN_UTILS_UNIQUE_IMPL_PTR` - * `IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR`, `IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR` + * `IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR`, `IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR` * `IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING`, `IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING` * `IGN_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION`, `IGN_UTILS_WARN_RESUME__DEPRECATED_DECLARATION` +* 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__