ign -> gz Partial Docs Migration and Project Name Followups : gz-plugin

CMakeLists.txt

@@ -39,7 +39,7 @@ gz_find_package(DL
 
 
 #--------------------------------------
-# Find ignition-tools
+# Find gz-tools
 find_program(GZ_TOOLS_PROGRAM gz)
 
 

Changelog.md

@@ -10,10 +10,10 @@
     * [Pull request #52](https://github.com/gazebosim/gz-plugin/pull/52)
     * [Pull request #51](https://github.com/gazebosim/gz-plugin/pull/51)
 
-1. Find gz program instead of ignition-tools
+1. Find gz program instead of gz-tools
     * [Pull request #57](https://github.com/gazebosim/gz-plugin/pull/57)
 
-1. Remove ign-tools from CMakeLists.txt. Not used
+1. Remove gz-tools from CMakeLists.txt. Not used
     * [Pull request #56](https://github.com/gazebosim/gz-plugin/pull/56)
 
 ### Gazebo Plugin 1.2.0 (2021-03-30)
@@ -48,7 +48,7 @@
 
 ### Gazebo Plugin 1.1.0 (2019-11-21)
 
-1. Add SelectSpecializers to allow ign-physics to improve compilation time.
+1. Add SelectSpecializers to allow gz-physics to improve compilation time.
     * [BitBucket pull request 32](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-physics/pull-requests/32)
 
 ### Gazebo Plugin 1.0.0 (2019-02-05)

Migration.md

@@ -27,3 +27,10 @@ release will remove the deprecated code.
 
 * `ignitionVersion()` is deprecated and will be removed in future versions.
   Use `gzVersion()` instead.
+
+* 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_<PROJECT>_<VISIBLE/HIDDEN>`
+    * CMake `-config` files
+    * Paths that depend on the project name

MigrationFromCommon.md

@@ -1,13 +1,13 @@
 # Migration Instructions (from common::Plugin)
 
 This file provides migration instructions for `ignition` library developers to
-replace the `ignition-common` plugin framework with the `ignition-plugin`
+replace the `gz-common` plugin framework with the `gz-plugin`
 framework. Some of the instructions here may also be useful to new adopters of
-`ignition-plugin`.
+`gz-plugin`.
 
 # Linking to ignition-plugin
 
-`ign-plugin` has three components: `core`, `loader`, and `register`. Code that
+`gz-plugin` has three components: `core`, `loader`, and `register`. Code that
 just wants to use `PluginPtr` objects can link to `core`, e.g.:
 
 ```
@@ -48,7 +48,7 @@ The name of the header for registering plugins has changed:
 
 * `<ignition/common/PluginMacros.hh>` should be replaced by `<ignition/plugin/Register.hh>`
 
-The old `ign-common` plugin registration method had numerous macros for registering
+The old `gz-common` plugin registration method had numerous macros for registering
 plugins. Those have all been replaced with `GZ_ADD_PLUGIN`. Specifically:
 
 * `IGN_COMMON_REGISTER_SINGLE_MACRO` can be directly replaced with `GZ_ADD_PLUGIN`.
@@ -77,10 +77,10 @@ you choose exactly one.
 
 # Loading a library
 
-The `gz::common::SystemPaths` class was not ported into `ign-plugin`
+The `gz::common::SystemPaths` class was not ported into `gz-plugin`
 because it is more related to filesystem utilities than to plugins. If you are
 currently using `gz::common::SystemPaths` to help with loading plugins,
-then you should continue to use it. It does not have a replacement in `ign-plugin`.
+then you should continue to use it. It does not have a replacement in `gz-plugin`.
 
 Here is a list of things that you *should* replace:
 
@@ -94,7 +94,7 @@ Here is a list of things that you *should* replace:
 Functions like `Plugin::QueryInterface()` and `Plugin::QueryInterfaceSharedPtr()`
 used to require a `std::string` argument with the name of the interface. This is
 no longer necessary, ever. Functions that accept `std::string` arguments will
-remain in the initial release 0 of `ign-plugin`, but they are marked as
+remain in the initial release 0 of `gz-plugin`, but they are marked as
 deprecated and will be removed by release 1. All interfaces can now be queried
 by simply passing the class as a template argument to a query function. This is
 a much safer method than relying on users to spell a string correctly.

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

appveyor.yml

@@ -12,7 +12,7 @@ install:
   - vcpkg install dlfcn-win32
   # ign-cmake
   - git clone https://github.com/gazebosim/gz-cmake -b gz11
-  - cd ign-cmake
+  - cd gz-cmake
   - md build
   - cd build
   - cmake .. -DBUILD_TESTING=OFF

examples/README.md

@@ -8,7 +8,7 @@ After installing Gazebo Plugin, from source or from binaries, build with:
 
 ```
 git clone https://github.com/gazebosim/gz-plugin/
-cd ign-plugin/examples
+cd gz-plugin/examples
 mkdir build
 cd build
 cmake ..

examples/integrators.cc

@@ -311,7 +311,7 @@ int main(int argc, char *argv[])
       "\nNumerical integrator plugins must inherit the NumericalIntegrator \n"
       "interface, and differential equation plugins must inherit the \n"
       "ODESystemFactory interface. Both interfaces can be found in the header\n"
-      "ign-plugin/examples/plugins/Interfaces.hh.\n\n"
+      "gz-plugin/examples/plugins/Interfaces.hh.\n\n"
 
       "Custom plugins can be used by passing in the custom plugin library\n"
       "directory to the -I flag, and the library name(s) to the -p flag,\n"

loader/CMakeLists.txt

@@ -2,7 +2,7 @@
 # "tests" variable
 gz_get_libsources_and_unittests(sources tests)
 
-# Disable gz_TEST if ignition-tools is not found
+# Disable gz_TEST if gz-tools is not found
 if (MSVC OR NOT GZ_TOOLS_PROGRAM)
   list(REMOVE_ITEM tests src/gz_TEST.cc)
 endif()

loader/conf/plugin.yaml.in

@@ -1,4 +1,4 @@
---- # Subcommands available inside ignition-plugin.
+--- # Subcommands available inside gz-plugin.
 format: 1.0.0
 library_name: @PROJECT_NAME_NO_VERSION@
 library_version: @PROJECT_VERSION_FULL@

loader/src/cmd/CMakeLists.txt

@@ -4,15 +4,15 @@ target_link_libraries(gz PUBLIC
   ${PROJECT_LIBRARY_TARGET_NAME}
 )
 
-set(plugin_executable ign-plugin)
+set(plugin_executable gz-plugin)
 add_executable(${plugin_executable} plugin_main.cc)
 target_link_libraries(${plugin_executable}
   gz
   gz-utils${GZ_UTILS_VER}::cli
   ${loader}
 )
 
-set(EXE_INSTALL_DIR "${CMAKE_INSTALL_LIBEXECDIR}/ignition/${IGN_DESIGNATION}${PROJECT_VERSION_MAJOR}")
+set(EXE_INSTALL_DIR "${CMAKE_INSTALL_LIBEXECDIR}/gz/${IGN_DESIGNATION}${PROJECT_VERSION_MAJOR}")
 
 install(
   TARGETS

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.
 
 
 **Contents**

tutorials/01_intro.md

@@ -32,5 +32,4 @@ name with a string.
 
 The [Gazebo Physics](https://gazebosim.org/libs/physics) Feature
 system provides a good example of the use of these unique aspects of
-ignition-plugin.
-
+gz-plugin.

tutorials/02_installation.md

@@ -1,7 +1,7 @@
 \page installation Installation
 
 These instructions are for installing only Gazebo Plugin.
-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.
 
@@ -32,15 +32,15 @@ wget http://packages.osrfoundation.org/gazebo.key -O - | sudo apt-key add -
 
 ## Binary Installation
 
-On Ubuntu systems, `apt-get` can be used to install `ignition-plugin`:
+On Ubuntu systems, `apt-get` can be used to install `gz-plugin`:
 ```bash
 sudo apt-get update
 sudo apt install libignition-plugin2-dev
 ```
 
 ## Source Installation
 
-1. Install Ignition dependencies
+1. Install Gazebo dependencies
   ```
   sudo apt-get install libignition-cmake3-dev libignition-tools2-dev libignition-utils2-cli-dev
   ```
@@ -56,7 +56,7 @@ sudo apt install libignition-plugin2-dev
 
 3. Configure and build
   ```bash
-  cd ign-plugin
+  cd gz-plugin
   mkdir build
   cd build
   cmake ..
@@ -106,7 +106,7 @@ Sierra (10.12) or later.
 
 3. Configure and build
   ```bash
-  cd ign-plugin
+  cd gz-plugin
   mkdir build
   cd build
   cmake ..
@@ -122,7 +122,7 @@ Sierra (10.12) or later.
 
 ## Prerequisites
 
-First, follow the [ign-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for creating a Conda environment.
+First, follow the [gz-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, and other prerequisites, and also for 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`).
 
@@ -145,7 +145,7 @@ which version you need.
 
 This assumes you have created and activated a Conda environment while installing the Prerequisites.
 
-1. Install Ignition dependencies:
+1. Install Gazebo dependencies:
 
   You can view available versions and their dependencies:
   ```bash
@@ -165,7 +165,7 @@ This assumes you have created and activated a Conda environment while installing
 
 3. Configure and build
   ```bash
-  cd ign-plugin
+  cd gz-plugin
   mkdir build
   cd build
   cmake .. -DBUILD_TESTING=OFF  # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
@@ -196,7 +196,7 @@ You can also generate the documentation from a clone of this repository by follo
 
 3. Configure and build the documentation.
   ```bash
-  cd ign-plugin
+  cd gz-plugin
   mkdir build
   cd build
   cmake ..
@@ -208,7 +208,7 @@ You can also generate the documentation from a clone of this repository by follo
   firefox doxygen/html/index.html
   ```
 
-**Note** Alternatively, documentation for `ignition-plugin` can be found within the source code, and also in the MIGRATION.md guide.
+**Note** Alternatively, documentation for `gz-plugin` can be found within the source code, and also in the MIGRATION.md guide.
 
 
 # Test