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

…on (#383) * Migrate some docs and project names in macros Signed-off-by: methylDragon <[email protected]> * Add project name migration note in Migration.md Signed-off-by: methylDragon <[email protected]> * Migrate libexec dirs Signed-off-by: methylDragon <[email protected]> * More aggressively migrate ign-libX mentions, even for older versions Signed-off-by: methylDragon <[email protected]> * More aggressive migrations for ignition- and ign- Signed-off-by: methylDragon <[email protected]>
gazebosim · Jun 28, 2022 · 22e0f02 · 22e0f02
1 parent ad84452
commit 22e0f02
Show file tree

Hide file tree

Showing 19 changed files with 68 additions and 62 deletions.
diff --git a/Changelog.md b/Changelog.md
@@ -77,7 +77,7 @@
 
 ## Gazebo Common 4.3.0 (2021-09-27)
 
-1. Remove ign-utils from TempDirectory
+1. Remove gz-utils from TempDirectory
     * [Pull request #248](https://github.com/gazebosim/gz-common/pull/248)
 
 1. Add functions and objects for Temporary Directories
@@ -163,7 +163,7 @@
 
 1. Add bazel buildsystem support
     * [Pull request #123](https://github.com/gazebosim/gz-common/pull/123)
->>>>>>> ign-common4
+>>>>>>> gz-common4
 
 ## Gazebo Common 4.0.0 (2021-03-30)
 
@@ -176,7 +176,7 @@
 1. Rotate capsule to Z-up
     * [Pull request #186](https://github.com/gazebosim/gz-common/pull/186)
 
-1. Add implementation pointer to ign-common classes
+1. Add implementation pointer to gz-common classes
     * [Pull request #163](https://github.com/gazebosim/gz-common/pull/163)
 
 1. Cleanup and add implementation pointer to Animation classes
@@ -535,7 +535,7 @@
 1. Filesystem functions to create unique paths
     * [BitBucket pull request 187](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-common/pull-requests/187)
 
-1. Battery additions for LinearBatteryPlugin port to ign-gazebo
+1. Battery additions for LinearBatteryPlugin port to gz-sim
     * [BitBucket pull request 186](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-common/pull-requests/186)
 
 1. Consolidate Console::log streams to reduce colored log size
@@ -548,7 +548,7 @@
 
 ## Gazebo Common 3.0.0 (2019-02-28)
 
-1. Use ign-cmake2 and support Ubuntu Bionic (18.04).
+1. Use gz-cmake2 and support Ubuntu Bionic (18.04).
     * [BitBucket pull request 131](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-common/pull-requests/131)
 
 1. WorkerPool: allow user to set minimum number of worker threads.

diff --git a/Migration.md b/Migration.md
@@ -44,12 +44,19 @@ release will remove the deprecated code.
    11. `IGN_DUMMY_PLUGIN_PATH`
    12. `IGNITION_UNITTEST_SPECIALIZED_PLUGIN_ACCESS`
 
+### Breaking Changes
 
+1. 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
 
 ### Additions
 
 1. **geospatial** component that loads heightmap images and DEMs
-    + Depends on the ign-common's `graphics` component and the `gdal` library
+    + Depends on the gz-common's `graphics` component and the `gdal` library
 
 ### Modifications
 
@@ -99,8 +106,8 @@ release will remove the deprecated code.
 
 ### Modifications
 
-1. Depends on **ignition-cmake2**
-    + Ignition-common now depends on ignition-cmake2.
+1. Depends on **gz-cmake2**
+    + gz-common now depends on gz-cmake2.
 
 1. Requires c++17.
 
@@ -110,12 +117,12 @@ release will remove the deprecated code.
 
 ### Modifications
 
-1. Depends on **ignition-cmake1**
-    + Ignition-common now depends on ignition-cmake1, which provides
+1. Depends on **gz-cmake1**
+    + gz-common now depends on gz-cmake1, which provides
       support for Component libraries.
 
 1. Component libraries
-    + Some classes have been moved from the main ignition-common library
+    + Some classes have been moved from the main gz-common library
       to component libraries. To use these features, you must
       list them in the `find_package` call and link against them.
       - av: audio and video playback and encoding
@@ -126,6 +133,6 @@ release will remove the deprecated code.
 
 ### Added dependencies
 
-1. **ignition-cmake**
-    + Ignition-math now has a build dependency on ignition-cmake, which
-      allows cmake scripts to be shared across all the ignition packages.
+1. **gz-cmake**
+    + gz-math now has a build dependency on gz-cmake, which
+      allows cmake scripts to be shared across all the Gazebo packages.
diff --git a/README.md b/README.md
@@ -14,8 +14,8 @@ Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon
 Homebrew      | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_common-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_common-ci-main-homebrew-amd64)
 Windows       | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_common-ci-main-windows7-amd64)](https://build.osrfoundation.org/job/ignition_common-ci-main-windows7-amd64)
 
-Gazebo Common, a component of [Ignition
-Robotics](https://gazebosim.org), provides a set of libraries that
+Gazebo Common, a component of [Gazebo
+Sim](https://gazebosim.org), provides a set of libraries that
 cover many different use cases. An audio-visual library supports
 processing audio and video files, a graphics library can load a variety 3D
 mesh file formats into a generic in-memory representation, and the core
@@ -102,4 +102,3 @@ This library uses [Semantic Versioning](https://semver.org/). Additionally, this
 # License
 
 This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0). See also the [LICENSE](https://github.com/gazebosim/gz-common/blob/main/LICENSE) file.
-
diff --git 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 libraries
+Gazebo @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of libraries
 designed to rapidly develop robot and simulation applications. 
 
 ## License

diff --git a/configure.bat b/configure.bat
@@ -5,7 +5,7 @@
 
 :: Install dependencies
 call %win_lib% :download_unzip_install dlfcn-win32-vc15-x64-dll-MD.zip
-call %win_lib% :install_ign_project ign-math main
+call %win_lib% :install_ign_project gz-math main
 
 :: Set configuration variables
 @set build_type=Release

diff --git a/examples/README.md b/examples/README.md
@@ -8,7 +8,7 @@ After installing Gazebo Common, from source or from binaries, build with:
 
 ```
 git clone https://github.com/gazebosim/gz-common/
-cd ign-common/examples
+cd gz-common/examples
 mkdir build
 cd build
 cmake ..

diff --git a/include/gz/common/SuppressWarning.hh b/include/gz/common/SuppressWarning.hh
@@ -20,10 +20,10 @@
 
 #include <gz/utils/SuppressWarning.hh>
 
-#pragma message("ign-common SuppressWarning is deprecated, use ign-utils")
-// These macros have been moved to ign-utils so they may be more broadly used.
+#pragma message("gz-common SuppressWarning is deprecated, use gz-utils")
+// These macros have been moved to gz-utils so they may be more broadly used.
 // The implementations are aliases to those implementations and are deprecated
-// in ign-common5 and are to be removed in ign-common6
+// in gz-common5 and are to be removed in gz-common6
 
 // This header contains cross-platform macros for suppressing warnings. Please
 // only use these macros responsibly when you are certain that the compiler is

diff --git a/profiler/src/CMakeLists.txt b/profiler/src/CMakeLists.txt
@@ -102,7 +102,7 @@ if(TARGET UNIT_Profiler_Remotery_TEST)
 endif()
 
 if(GZ_PROFILER_REMOTERY)
-  set(GZ_PROFILER_SCRIPT_PATH ${CMAKE_INSTALL_LIBEXECDIR}/ignition/ignition-common${PROJECT_VERSION_MAJOR})
+  set(GZ_PROFILER_SCRIPT_PATH ${CMAKE_INSTALL_LIBEXECDIR}/gz/gz-common${PROJECT_VERSION_MAJOR})
   set(GZ_PROFILER_VIS_PATH ${IGN_DATA_INSTALL_DIR}/profiler_vis)
 
   configure_file(Remotery/ign_remotery_vis.in

diff --git a/profiler/src/RemoteryProfilerImpl.cc b/profiler/src/RemoteryProfilerImpl.cc
@@ -184,7 +184,7 @@ RemoteryProfilerImpl::RemoteryProfilerImpl()
     static_cast<RemoteryProfilerImpl *>(_context)->HandleInput(_text);
   };
 
-  gzdbg << "Starting ign-common profiler impl: Remotery" <<
+  gzdbg << "Starting gz-common profiler impl: Remotery" <<
     " (port: " << this->settings->port << ")" << std::endl;
   rmtError error;
   error = rmt_CreateGlobalInstance(&this->rmt);

diff --git a/src/PluginUtils_TEST.cc b/src/PluginUtils_TEST.cc
@@ -32,8 +32,8 @@ TEST(PluginUtils, NormalizeName)
   EXPECT_EQ("::", common::NormalizeName(""));
   EXPECT_EQ("::", common::NormalizeName("::"));
 
-  EXPECT_EQ("::ignition", common::NormalizeName("ignition"));
-  EXPECT_EQ("::ignition", common::NormalizeName("::ignition"));
+  EXPECT_EQ("::gz", common::NormalizeName("gz"));
+  EXPECT_EQ("::gz", common::NormalizeName("::gz"));
 
   EXPECT_EQ("::gz::math", common::NormalizeName("gz::math"));
   EXPECT_EQ("::gz::math", common::NormalizeName("::gz::math"));

diff --git a/src/SignalHandler.cc b/src/SignalHandler.cc
@@ -16,7 +16,7 @@
 */
 
 // Suppressing cpplint.py because tools/cpplint.py is old. Remove the NOLINT
-// comments when upgrading to ign-cmake's "make codecheck"
+// comments when upgrading to gz-cmake's "make codecheck"
 #include "gz/common/SignalHandler.hh" // NOLINT(*)
 #include <csignal> // NOLINT(*)
 #include <functional> // NOLINT(*)

diff --git a/src/SignalHandler_TEST.cc b/src/SignalHandler_TEST.cc
@@ -16,7 +16,7 @@
 */
 
 // Suppressing cpplint.py because tools/cpplint.py is old. Remove the NOLINT
-// comments when upgrading to ign-cmake's "make codecheck"
+// comments when upgrading to gz-cmake's "make codecheck"
 #include "gz/common/SignalHandler.hh" // NOLINT(*)
 #include <gtest/gtest.h> // NOLINT(*)
 #include <csignal> // NOLINT(*)

diff --git a/src/URI.cc b/src/URI.cc
@@ -578,7 +578,7 @@ bool URIPath::Valid(const std::string &_str)
 
   // TODO(anyone): the space should not be
   // there, but leaving it out breaks
-  // other stuff, e.g. ign-fuel-tools
+  // other stuff, e.g. gz-fuel-tools
   // now have URIs with unencoded spaces
   const std::string allowedChars = "qwertzuiopasdfghjklyxcvbnm"
                                    "QWERTZUIOPASDFGHJKLYXCVBNM"

diff --git a/test/performance/CMakeLists.txt b/test/performance/CMakeLists.txt
@@ -1,7 +1,7 @@
 gz_get_sources(tests)
 
 # plugin_specialization test causes lcov to hang
-# see ign-cmake issue 25
+# see gz-cmake issue 25
 if("${CMAKE_BUILD_TYPE_UPPERCASE}" STREQUAL "COVERAGE")
   list(REMOVE_ITEM tests
     plugin_specialization.cc)

diff --git a/testing/include/gz/common/testing/TestPaths.hh b/testing/include/gz/common/testing/TestPaths.hh
@@ -39,7 +39,7 @@ namespace gz::common::testing
 ///
 /// For CMake builds, it is expected that this is injected via a
 /// buildsystem define of TESTING_PROJECT_SOURCE_DIR.
-/// This is done automatically for tests using ign-cmake's ign_build_tests
+/// This is done automatically for tests using gz-cmake's ign_build_tests
 ///
 /// For Bazel builds, it is expected to be empty
 constexpr char kTestingProjectSourceDir[] = TESTING_PROJECT_SOURCE_DIR;
@@ -151,7 +151,7 @@ TestPathFactory(
 //////////////////////////////////////////////////
 /// \brief Get the path to a file in the project source tree
 ///
-/// Example: to get ign-common/test/data/box.dae
+/// Example: to get gz-common/test/data/box.dae
 /// SourceFile("test", "data", "box.dae");
 ///
 /// \param[in] args Relative path to the source file
@@ -170,7 +170,7 @@ std::string SourceFile(Args const &... args)
 //////////////////////////////////////////////////
 /// \brief Get the path to a file in the project test directory tree
 ///
-/// Example: to get ign-common/test/data/box.dae
+/// Example: to get gz-common/test/data/box.dae
 /// TestFile("data", "box.dae");
 ///
 /// \param[in] args Path to the file, relative to the test directory

diff --git 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/hw-encoding.md b/tutorials/hw-encoding.md
@@ -291,5 +291,5 @@ which jobs of the other users are using NVEnc.
 
 There is a workaround removing this artificial limit - patching the binary blob
 drivers using https://github.com/keylase/nvidia-patch . This is an unofficial
-patch that is not supported by NVidia or the Ignition developers. It is up to
+patch that is not supported by NVidia or the Gazebo developers. It is up to
 you if you can and want to do that. And there is no guarantee it will work forever.
diff --git a/tutorials/install.md b/tutorials/install.md
@@ -3,7 +3,7 @@
 Next Tutorial: \ref profiler
 
 These instructions are for installing only Gazebo Common.
-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.
 
@@ -13,7 +13,7 @@ The Source Installation instructions should be used if you need the very latest
 
 ## Ubuntu
 
-On Ubuntu systems, `apt-get` can be used to install `ignition-common`:
+On Ubuntu systems, `apt-get` can be used to install `gz-common`:
 ```
 sudo apt install libignition-common<#>-dev
 ```
@@ -44,11 +44,11 @@ Miniconda suffices.
 
 Create if necessary, and activate a Conda environment:
 ```
-conda create -n ign-ws
-conda activate ign-ws
+conda create -n gz-ws
+conda activate gz-ws
 ```
 
-Install `ignition-common`:
+Install `gz-common`:
 ```
 conda install libignition-common<#> --channel conda-forge
 ```
@@ -83,21 +83,21 @@ The AV component requires:
 
 ### Windows
 
-First, follow the [ign-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and creating a Conda environment.
+First, follow the [gz-cmake](https://github.com/gazebosim/gz-cmake) tutorial for installing Conda, Visual Studio, CMake, etc., prerequisites, and 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`).
 
 Activate the Conda environment:
 ```
-conda activate ign-ws
+conda activate gz-ws
 ```
 
 Install prerequisites:
 ```
 conda install freeimage gts glib dlfcn-win32 ffmpeg --channel conda-forge
 ```
 
-Install Ignition dependencies:
+Install Gazebo dependencies:
 
 You can view available versions and their dependencies:
 ```
@@ -120,7 +120,7 @@ conda install libignition-cmake<#> libignition-math<#> --channel conda-forge
 
 2. Configure and build
   ```
-  cd ign-common
+  cd gz-common
   mkdir build
   cd build
   cmake ..
@@ -150,7 +150,7 @@ conda install libignition-cmake<#> libignition-math<#> --channel conda-forge
 
 3. Configure and build
   ```
-  cd ign-common
+  cd gz-common
   mkdir build
   cd build
   cmake ..
@@ -174,7 +174,7 @@ This assumes you have created and activated a Conda environment while installing
 
 2. Configure and build
   ```
-  cd ign-common
+  cd gz-common
   mkdir build
   cd build
   cmake .. -DBUILD_TESTING=OFF  # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
@@ -204,7 +204,7 @@ You can also generate the documentation from a clone of this repository by follo
 
 3. Configure and build the documentation.
   ```
-  cd ign-common
+  cd gz-common
   mkdir build
   cd build
   cmake ../