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

…-tools (#268) * 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]> * 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 · a877872 · a877872
1 parent 85b48a2
commit a877872
Show file tree

Hide file tree

Showing 13 changed files with 44 additions and 36 deletions.
diff --git a/.github/ci/after_make.sh b/.github/ci/after_make.sh
@@ -5,7 +5,7 @@ set -x
 # Install
 make install
 
-# So ign-tools finds fuel-tools
+# So gz-tools finds fuel-tools
 export GZ_CONFIG_PATH=/usr/local/share/ignition
 export LD_LIBRARY_PATH=/usr/local/lib/:$LD_LIBRARY_PATH
 

diff --git a/Changelog.md b/Changelog.md
@@ -6,7 +6,7 @@
 
 ### Gazebo Fuel Tools 7.0.0 (2021-09-28)
 
-1. Depend on ign-msgs8
+1. Depend on gz-msgs8
     * [Pull request #182](https://github.com/gazebosim/gz-fuel-tools/pull/182)
 
 1. Infrastructure
@@ -40,7 +40,7 @@
 
 ### Gazebo Fuel Tools 6.1.0 (2021-10-15)
 
-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 #191](https://github.com/gazebosim/gz-fuel-tools/pull/191)
 
 1. Added fuel update command
@@ -58,10 +58,10 @@
 
 ### Gazebo Fuel Tools 6.0.0 (2021-03-30)
 
-1. Depend on ign-common4
+1. Depend on gz-common4
     * [Pull request #163](https://github.com/gazebosim/gz-fuel-tools/pull/163)
 
-1. Depend on ign-msgs7
+1. Depend on gz-msgs7
     * [Pull request #158](https://github.com/gazebosim/gz-fuel-tools/pull/158)
 
 1. Unset DELETE method on Windows
@@ -83,7 +83,7 @@
 1. APIs for retrieving models in parallel
     * [Pull request #199](https://github.com/gazebosim/gz-fuel-tools/pull/199)
 
-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 #191](https://github.com/gazebosim/gz-fuel-tools/pull/191)
 
 1. Added `gz fuel update` command
@@ -140,7 +140,7 @@
 1. Fixed test - Download world 2
     * [Pull request 110](https://github.com/gazebosim/gz-fuel-tools/pull/110)
 
-### Ignition Fuel Tools 4.5.0 (2022-06-01)
+### Gazebo Fuel Tools 4.5.0 (2022-06-01)
 
 1. APIs for retrieving models in parallel
     * [Pull request #199](https://github.com/gazebosim/gz-fuel-tools/pull/199)
@@ -163,7 +163,7 @@
 1. FuelClient.cc: include <deque>
     * [Pull request #213](https://github.com/gazebosim/gz-fuel-tools/pull/213)
 
-### Ignition Fuel Tools 4.4.0 (2021-06-17)
+### Gazebo Fuel Tools 4.4.0 (2021-06-17)
 
 1. Remove `tools/code_check` and update codecov
     * [Pull request #187](https://github.com/gazebosim/gz-fuel-tools/pull/187)
@@ -237,7 +237,7 @@
 
 ### Gazebo Fuel Tools 4.0.0 (2019-12-10)
 
-1. Model upload CLI, resource metadata CLI, depend on ign-msgs5.
+1. Model upload CLI, resource metadata CLI, depend on gz-msgs5.
     * [BitBucket pull request 108](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-fuel-tools/pull-requests/108)
 
 ## Gazebo Fuel Tools 3.x
@@ -328,8 +328,8 @@
 
 ### Gazebo Fuel Tools 3.0.0 (2018-02-28)
 
-1. Integration with ign-gazebo. The following set of pull requests update
-   fuel-tools to use ign-cmake2, sets api.ignitionfuel.org as the default
+1. Integration with gz-sim. The following set of pull requests update
+   fuel-tools to use gz-cmake2, sets api.ignitionfuel.org as the default
    server, fixes codecheck errors, removes old deprecations, and parses
    model.config files using tinyxml2.
     * [BitBucket pull request 82](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-fuel-tools/pull-requests/82)

diff --git a/INSTALL_WINDOWS.md b/INSTALL_WINDOWS.md
@@ -28,12 +28,12 @@ need to [disable the Windows firewall](http://windows.microsoft.com/en-us/window
 1. Clone Gazebo Fuel-Tools:
 
         git clone https://github.com/gazebosim/gz-fuel-tools
-        cd ign-fuel-tools
+        cd gz-fuel-tools
         mkdir build
 
 1. In the Windows Command Prompt, configure and build:
 
-	    cd ign-fuel-tools\build
+	    cd gz-fuel-tools\build
         ..\configure
         nmake install
 
@@ -44,5 +44,5 @@ need to [disable the Windows firewall](http://windows.microsoft.com/en-us/window
 
 1. In the Windows Command Prompt, run the test suite:
 
-    cd ign-fuel-tools\build
+    cd gz-fuel-tools\build
     ctest
diff --git a/Migration.md b/Migration.md
@@ -11,6 +11,14 @@
   Use the `gz_` prefix instead.
   * `ign_strcat`, `ign_strcpy`, `ign_sprintf`, `ign_strdup`
 
+### 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_<PROJECT>_<VISIBLE/HIDDEN>`
+    * CMake `-config` files
+    * Paths that depend on the project name
 
 ## Gazebo Fuel Tools 5.X to 6.X
 

diff --git a/README.md b/README.md
@@ -166,10 +166,10 @@ sudo apt install ruby-ffi libzip-dev libcurl-dev libjsoncpp-dev
 # 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
@@ -178,7 +178,7 @@ export GZ_CONFIG_PATH=/usr/local/share/gz
 However, that environment variable only takes a single path, which means if the
 installations from source are in different locations, only one can be specified.
 
-Another workaround for working with multiple Ignition libraries on the command
+Another workaround for working with multiple Gazebo libraries on the command
 line is using symbolic links to each library's YAML file.
 ```
 mkdir ~/.ignition/tools/configs -p

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
@@ -8,10 +8,10 @@ call %win_lib% :download_unzip_install curl-7.57.0-vc15-x64-dll-MD.zip
 call %win_lib% :download_unzip_install jsoncpp-1.8.4-vc15-x64-dll-MD.zip
 call %win_lib% :download_unzip_install libyaml-0.1.7-vc15-x64-md.zip
 call %win_lib% :download_unzip_install libzip-1.4.0_zlip-1.2.11_vc15-x64-dll-MD.zip
-call %win_lib% :install_ign_project ign-cmake ign-cmake3
-call %win_lib% :install_ign_project ign-tools ign-tools2
-call %win_lib% :install_ign_project ign-common main
-call %win_lib% :install_ign_project ign-msgs main
+call %win_lib% :install_ign_project gz-cmake gz-cmake3
+call %win_lib% :install_ign_project gz-tools gz-tools2
+call %win_lib% :install_ign_project gz-common main
+call %win_lib% :install_ign_project gz-msgs main
 
 :: Set configuration variables
 @set build_type=Release

diff --git a/example/README.md b/example/README.md
@@ -23,7 +23,7 @@ After installing Gazebo Fuel tools, from source or from binaries, build with:
 
 ```
 git clone https://github.com/gazebosim/gz-fuel-tools/
-cd ign-fuel-tools/example
+cd gz-fuel-tools/example
 mkdir build
 cd build
 cmake ..

diff --git a/src/Helpers_TEST.cc b/src/Helpers_TEST.cc
@@ -25,7 +25,7 @@ using namespace fuel_tools;
 /////////////////////////////////////////////////
 TEST(HelpersTEST, UriToPathNoAuthority)
 {
-// TO-DO: Update this test after ign-fuel-tools#204 is addressed
+// TO-DO: Update this test after gz-fuel-tools#204 is addressed
 #ifdef WIN32
   const std::string testStr1 = R"(localhost:8000\some\path)";
   const std::string testStr2 = R"(localhost:8000\some\path\)";

diff --git a/src/LocalCache.cc b/src/LocalCache.cc
@@ -603,9 +603,9 @@ void LocalCachePrivate::FixPathsInUri(tinyxml2::XMLElement *_elem,
     // owner
     gzdbg << "Model [" << _id.Name()
            << "] loading resource from another model, named [" << resourceName
-           << "]. On Blueprint (ign-fuel-tools 3) and Citadel "
-           << "(ign-fuel-tools 4), [" << resourceName << "] is ignored. "
-           << "From Dome (ign-fuel-tools 5), [" << _id.Name()
+           << "]. On Blueprint (gz-fuel-tools 3) and Citadel "
+           << "(gz-fuel-tools 4), [" << resourceName << "] is ignored. "
+           << "From Dome (gz-fuel-tools 5), [" << _id.Name()
            << "] will be used. If [" << resourceName
            << "] is not a model belonging to owner [" << _id.Owner()
            << "], fix your SDF file!" << std::endl;

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/01_installation.md b/tutorials/01_installation.md
@@ -182,7 +182,7 @@ sudo make uninstall
 
 3. Configure and build
   ```
-  cd ign-fuel-tools
+  cd gz-fuel-tools
   mkdir build
   cd build
   cmake ..
@@ -193,7 +193,7 @@ sudo make uninstall
 
 #### Prerequisites
 
-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``).
 
@@ -208,14 +208,14 @@ Install dependencies:
 conda install jsoncpp libzip --channel conda-forge
 ```
 
-Install Ignition dependencies:
+Install Gazebo dependencies:
 
 You can view available versions and their dependencies:
 ```
 conda search libignition-fuel-tools* --channel conda-forge --info
 ```
 
-Install Ignition dependencies, replacing `<#>` with the desired versions:
+Install Gazebo dependencies, replacing `<#>` with the desired versions:
 ```
 conda install libignition-cmake<#> libignition-common<#> libignition-msgs<#> libignition-tools<#> --channel conda-forge
 ```
@@ -235,7 +235,7 @@ conda install libignition-cmake<#> libignition-common<#> libignition-msgs<#> lib
 
 3. Configure and build
   ```
-  cd ign-fuel-tools
+  cd gz-fuel-tools
   mkdir build
   cd build
   cmake .. -DBUILD_TESTING=OFF  # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install

diff --git a/tutorials/03_command_line.md b/tutorials/03_command_line.md
@@ -4,7 +4,7 @@ Next Tutorial: \ref cppapi
 
 ## Overview
 
-The `gz fuel` command line tool provides a convenient way to handle Ignition
+The `gz fuel` command line tool provides a convenient way to handle Gazebo
 Fuel resources from a terminal.
 
 ## List resources