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

CMakeLists.txt

@@ -94,7 +94,7 @@ gz_find_package (Qt5
 )
 
 set(GZ_GUI_PLUGIN_INSTALL_DIR
-  ${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins
+  ${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/gz-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins
 )
 
 #============================================================================

CONTRIBUTING.md

@@ -1 +1 @@
-See the [Ignition contributing guide](https://gazebosim.org/docs/all/contributing).
+See the [Gazebo contributing guide](https://gazebosim.org/docs/all/contributing).

Changelog.md

@@ -55,7 +55,7 @@
 1. Don't crash if a plugin has invalid QML
     * [Pull request #315](https://github.com/gazebosim/gz-gui/pull/315)
 
-1. Added log storing for ign-gui
+1. Added log storing for gz-gui
     * [Pull request #272](https://github.com/gazebosim/gz-gui/pull/272)
 
 ### Gazebo GUI 6.1.0 (2021-11-05)
@@ -102,7 +102,7 @@
     1. Marker Manager
         * [Pull request #247](https://github.com/gazebosim/gz-gui/pull/247)
 
-    1. Moved tape measure and grid config from ign-gazebo to ign-gui
+    1. Moved tape measure and grid config from gz-sim to gz-gui
         * [Pull request #236](https://github.com/gazebosim/gz-gui/pull/236)
 
 1. PIMPL GUI events
@@ -129,7 +129,7 @@
 1. Remove deprecations: tock
     * [Pull request #243](https://github.com/gazebosim/gz-gui/pull/243)
 
-1. Depend on ign-msgs8, ign-transport11, ign-rendering6
+1. Depend on gz-msgs8, gz-transport11, gz-rendering6
     * [Pull request #210](https://github.com/gazebosim/gz-gui/pull/210)
 
 1. Infrastructure
@@ -184,7 +184,7 @@
 1. Don't crash if a plugin has invalid QML
     * [Pull request #315](https://github.com/gazebosim/gz-gui/pull/315)
 
-1. Added log storing for ign-gui
+1. Added log storing for gz-gui
     * [Pull request #272](https://github.com/gazebosim/gz-gui/pull/272)
 
 
@@ -219,7 +219,7 @@
 1. Screenshot plugin fixed dbg message
     * [Pull request #246](https://github.com/gazebosim/gz-gui/pull/246)
 
-1. Detect gz instead of using cmake module to check for ignition-tools
+1. Detect gz instead of using cmake module to check for gz-tools
     * [Pull request #240](https://github.com/gazebosim/gz-gui/pull/240)
 
 ### Gazebo GUI 5.1.0 (2021-06-23)
@@ -262,13 +262,13 @@
 
 ### Gazebo GUI 5.0.0 (2021-03-31)
 
-1. Bump in edifice: ign-common4
+1. Bump in edifice: gz-common4
     * [Pull request #169](https://github.com/gazebosim/gz-gui/pull/169)
 
-1. Bump in edifice: ign-msgs7 and ign-transport10
+1. Bump in edifice: gz-msgs7 and gz-transport10
     * [Pull request #167](https://github.com/gazebosim/gz-gui/pull/167)
 
-1. Bump in edifice: ign-rendering5
+1. Bump in edifice: gz-rendering5
     * [Pull request #141](https://github.com/gazebosim/gz-gui/pull/141)
 
 1. Documentation updates
@@ -299,12 +299,12 @@
 1. Screenshot plugin fixed dbg message
     * [Pull request #246](https://github.com/gazebosim/gz-gui/pull/246)
 
-1. Detect gz instead of using cmake module to check for ignition-tools
+1. Detect gz instead of using cmake module to check for gz-tools
     * [Pull request #240](https://github.com/gazebosim/gz-gui/pull/240)
 
 ### Gazebo GUI 4.4.0 (2021-06-21)
 
-1. Bump required ign-rendering version to 4.8
+1. Bump required gz-rendering version to 4.8
     * [Pull request #234](https://github.com/gazebosim/gz-gui/pull/234)
 
 1. Update codeowners
@@ -337,7 +337,7 @@
 1. Improve the height of plugins in the right split
     * [Pull request #194](https://github.com/gazebosim/gz-gui/pull/194)
 
-1. Scene3D: port mesh material fixes from ign-gazebo
+1. Scene3D: port mesh material fixes from gz-sim
     * [Pull request #191](https://github.com/gazebosim/gz-gui/pull/191)
 
 ### Gazebo GUI 4.3.0 (2021-03-11)
@@ -458,10 +458,10 @@
 1. Depend on QtCharts and change application base class to QApplication
     * [BitBucket pull request 252](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/252)
 
-1. Depend on ign-msgs6 and ign-transport9
+1. Depend on gz-msgs6 and gz-transport9
     * [Pull request 92](https://github.com/gazebosim/gz-gui/pull/92)
 
-1. Depend on ign-rendering4
+1. Depend on gz-rendering4
     * [BitBucket pull request 243](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/243)
 
 ## Gazebo GUI 3
@@ -503,7 +503,7 @@
 1. 👩‍🌾 Remove bitbucket-pipelines.yml
     * [Pull request #274](https://github.com/gazebosim/gz-gui/pull/274)
 
-1. Require ign-rendering 3.5
+1. Require gz-rendering 3.5
     * [Pull request #264](https://github.com/gazebosim/gz-gui/pull/264)
 
 1. New teleop plugin implementation.
@@ -523,7 +523,7 @@
 1. Screenshot plugin fixed dbg message
     * [Pull request #246](https://github.com/gazebosim/gz-gui/pull/246)
 
-1. Detect gz instead of using cmake module to check for ignition-tools
+1. Detect gz instead of using cmake module to check for gz-tools
     * [Pull request #240](https://github.com/gazebosim/gz-gui/pull/240)
 
 ### Gazebo GUI 3.6.0 (2021-06-17)
@@ -554,7 +554,7 @@
 
 ### Gazebo GUI 3.5.1 (2021-03-18)
 
-1. Scene3D: port mesh material fixes from ign-gazebo
+1. Scene3D: port mesh material fixes from gz-sim
     * [Pull request #191](https://github.com/gazebosim/gz-gui/pull/191)
 
 1. Improve the height of plugins in the right split
@@ -688,7 +688,7 @@
 
 ### Gazebo GUI 3.1.0 (2020-03-27)
 
-1. Remove old ign-gui0 stuff
+1. Remove old gz-gui0 stuff
     * [BitBucket pull request 248](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/248)
 
 1. Fix homebrew warnings
@@ -740,10 +740,10 @@
 
 ### Gazebo GUI 3.0.0 (2019-12-10)
 
-1. Depend on ign-transport8 and ign-msgs5
+1. Depend on gz-transport8 and gz-msgs5
     * [BitBucket pull request 225](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/225)
 
-1. Depend on ign-rendering3
+1. Depend on gz-rendering3
     * [BitBucket pull request 221](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/221)
 
 ## Gazebo GUI 2
@@ -885,7 +885,7 @@
 1. Move files not ported to v1 to a separate dir for clarity.
     * [BitBucket pull request 196](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/196)
 
-1. Get ign-gui plugin interface in case there are others.
+1. Get gz-gui plugin interface in case there are others.
     * [BitBucket pull request 186](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gui/pull-requests/186)
 
 ### Gazebo GUI 1.0.0

Migration.md

@@ -13,12 +13,19 @@ release will remove the deprecated code.
 * Header files under `ignition/...` are deprecated and will be removed in future versions.
   Please use `gz/...` instead.
 
-* The `ignition-gui` element is deprecated and will be removed.
+* The `gz-gui` element is deprecated and will be removed.
   Please use `gz-gui` instead.
 
 * `ignitionVersion()` is deprecated and will be removed in future versions.
   Please 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
+
 ## Gazebo GUI 6.2 to 6.3
 
 * New QML dependencies, only needed for the NavSatMap plugin: `qml-module-qtlocation`, `qml-module-qtpositioning`

README.md

@@ -61,10 +61,10 @@ for usage instructions and API documentation.
 ## 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
@@ -99,7 +99,7 @@ export GZ_CONFIG_PATH=/user/local/share/gz/:/path/to/some/other/location
 
 * `tutorials`: Markdown files for the [tutorials](https://gazebosim.org/api/gui/5.0/tutorials.html).
 
-* `conf`: Files needed by [ign-tools](https://github.com/gazebosim/gz-tools).
+* `conf`: Files needed by [gz-tools](https://github.com/gazebosim/gz-tools).
 
 * `doc`: Files used by Doxygen when generating documentation.
 
@@ -115,7 +115,7 @@ Please see
 
 # Versioning
 
-This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Ignition 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 release information.
+This library uses [Semantic Versioning](https://semver.org/). Additionally, this library is part of the [Gazebo project](https://gazebosim.org) which periodically releases a versioned set of compatible and complimentary libraries. See the [Gazebo website](https://gazebosim.org) for version and release information.
 
 # License
 

api.md.in

@@ -1,6 +1,6 @@
-## Ignition @IGN_DESIGNATION_CAP@
+## Gazebo @IGN_DESIGNATION_CAP@
 
-Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition, 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

conf/gui.yaml.in

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

include/gz/gui/GuiEvents.hh

@@ -40,7 +40,7 @@ namespace gz
     namespace events
     {
       /// User defined events should start from QEvent::MaxUser and
-      /// count down to avoid collision with ign-gazebo events
+      /// count down to avoid collision with gz-sim events
 
       /// \brief Event called in the render thread of a 3D scene after the user
       /// camera has rendered.

include/gz/gui/config.hh.in

@@ -30,6 +30,6 @@
 
 #define GZ_GUI_VERSION_HEADER "Gazebo GUI, version ${PROJECT_VERSION_FULL}\nCopyright (C) 2017 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n"
 
-#define GZ_GUI_PLUGIN_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins"
+#define GZ_GUI_PLUGIN_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/gz-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins"
 
 #endif

src/plugins/camera_tracking/CameraTracking.cc

@@ -22,7 +22,7 @@
 #include <gz/common/Profiler.hh>
 #include <gz/plugin/Register.hh>
 
-// TODO(anyone) Remove these pragmas once ign-rendering and ign-msgs
+// TODO(anyone) Remove these pragmas once gz-rendering and gz-msgs
 // are disabling the warnings
 #ifdef _MSC_VER
 #pragma warning(push, 0)

src/plugins/grid_config/GridConfig.cc

@@ -279,7 +279,7 @@ void GridConfig::ConnectToGrid()
         gzdbg << "Connected to grid [" << grid->Name() << "]" << std::endl;
 
         // TODO(chapulina) Set to the grid's visible state when that's available
-        // through ign-rendering's API
+        // through gz-rendering's API
         this->dataPtr->visible = true;
         grid->Parent()->SetVisible(true);
 

src/plugins/grid_config/GridConfig.hh

@@ -15,8 +15,8 @@
  *
 */
 
-#ifndef GZ_GAZEBO_GUI_GRIDCONFIG_HH_
-#define GZ_GAZEBO_GUI_GRIDCONFIG_HH_
+#ifndef GZ_GUI_GRIDCONFIG_HH_
+#define GZ_GUI_GRIDCONFIG_HH_
 
 #include <memory>
 

src/plugins/minimal_scene/MinimalScene.cc

@@ -631,14 +631,14 @@ void IgnRenderer::SetGraphicsAPI(const rendering::GraphicsAPI &_graphicsAPI)
 
   if (_graphicsAPI == rendering::GraphicsAPI::OPENGL)
   {
-    gzdbg << "Creating ign-rendering interface for OpenGL" << std::endl;
+    gzdbg << "Creating gz-rendering interface for OpenGL" << std::endl;
     this->dataPtr->rhiParams["useCurrentGLContext"] = "1";
     this->dataPtr->rhi = std::make_unique<IgnCameraTextureRhiOpenGL>();
   }
 #ifdef __APPLE__
   else if (_graphicsAPI == rendering::GraphicsAPI::METAL)
   {
-    gzdbg << "Creating ign-renderering interface for Metal" << std::endl;
+    gzdbg << "Creating gz-renderering interface for Metal" << std::endl;
     this->dataPtr->rhiParams["metal"] = "1";
     this->dataPtr->rhi = std::make_unique<IgnCameraTextureRhiMetal>();
   }

src/plugins/minimal_scene/MinimalScene.hh

@@ -122,8 +122,8 @@ namespace plugins
 
   class RenderSync;
 
-  /// \brief Ign-rendering renderer.
-  /// All ign-rendering calls should be performed inside this class as it makes
+  /// \brief gz-rendering renderer.
+  /// All gz-rendering calls should be performed inside this class as it makes
   /// sure that opengl calls in the underlying render engine do not interfere
   /// with QtQuick's opengl render operations. The main Render function will
   /// render to an offscreen texture and notify via signal and slots when it's
@@ -300,7 +300,7 @@ namespace plugins
     /// On macOS this must be run on the main thread
     public: std::string Initialize();
 
-    /// \brief Ign-rendering renderer
+    /// \brief gz-rendering renderer
     public: IgnRenderer ignRenderer;
 
     /// \brief Pointer to render interface to handle OpenGL/Metal compatibility

src/plugins/minimal_scene/MinimalSceneRhi.hh

@@ -51,7 +51,7 @@ namespace plugins
     public: virtual void TextureId(void* _texturePtr) = 0;
   };
 
-  /// \brief Ign-rendering renderer.
+  /// \brief gz-rendering renderer.
   class IgnRenderer;
   class RenderSync;
 

src/plugins/scene3d/Scene3D.cc

@@ -35,7 +35,7 @@
 #include <gz/math/Vector2.hh>
 #include <gz/math/Vector3.hh>
 
-// TODO(louise) Remove these pragmas once ign-rendering and ign-msgs
+// TODO(louise) Remove these pragmas once gz-rendering and gz-msgs
 // are disabling the warnings
 #ifdef _MSC_VER
 #pragma warning(push, 0)
@@ -160,16 +160,16 @@ namespace plugins
     /// \param[in] _entity Entity to delete
     private: void DeleteEntity(const unsigned int _entity);
 
-    //// \brief Ign-transport scene service name
+    //// \brief gz-transport scene service name
     private: std::string service;
 
-    //// \brief Ign-transport pose topic name
+    //// \brief gz-transport pose topic name
     private: std::string poseTopic;
 
-    //// \brief Ign-transport deletion topic name
+    //// \brief gz-transport deletion topic name
     private: std::string deletionTopic;
 
-    //// \brief Ign-transport scene topic name
+    //// \brief gz-transport scene topic name
     private: std::string sceneTopic;
 
     //// \brief Pointer to the rendering scene
@@ -1575,8 +1575,8 @@ void RenderWindowItem::SetSceneTopic(const std::string &_topic)
 Scene3D::Scene3D()
   : Plugin(), dataPtr(new Scene3DPrivate)
 {
-  gzwarn << "This plugin is deprecated on ign-gui v6 and will be removed on "
-          << "ign-gui v7. Use MinimalScene + TransportSceneManager instead."
+  gzwarn << "This plugin is deprecated on gz-gui v6 and will be removed on "
+          << "gz-gui v7. Use MinimalScene + TransportSceneManager instead."
           << std::endl;
 
   qmlRegisterType<RenderWindowItem>("RenderWindow", 1, 0, "RenderWindow");