ign -> gz CLI Migration : gz-sim (gazebosim#1533)

Signed-off-by: methylDragon <[email protected]>

Author: methylDragon

.github/ci/after_make.sh

@@ -8,7 +8,7 @@ make install
 export LD_LIBRARY_PATH=${LD_LIBRARY_PATH}:/usr/local/lib
 
 # For ign-tools
-export GZ_CONFIG_PATH=/usr/local/share/ignition
+export GZ_CONFIG_PATH=/usr/local/share/gz
 
 # For rendering / window tests
 Xvfb :1 -screen 0 1280x1024x24 &

Changelog.md

@@ -357,7 +357,7 @@
 1. Sensor systems work if loaded after sensors
     * [Pull request #1104](https://github.com/gazebosim/gz-sim/pull/1104)
 
-1. Support printing sensors using `ign model`
+1. Support printing sensors using `gz model`
     * [Pull request #1157](https://github.com/gazebosim/gz-sim/pull/1157)
 
 1. Set camera clipping plane distances from the GUI
@@ -956,7 +956,7 @@
 1. 3 to 4
     * [Pull request #933](https://github.com/gazebosim/gz-sim/pull/933)
 
-1. Model info CLI `ign model`
+1. Model info CLI `gz model`
     * [Pull request #893](https://github.com/gazebosim/gz-sim/pull/893)
 
 1. Support Bullet on Edifice
@@ -1729,7 +1729,7 @@
 1. Fix to handle multiple logical cameras.
     * [Pull Request 539](https://github.com/gazebosim/gz-sim/pull/539)
 
-1. Improve ign tool support on macOS.
+1. Improve gz tool support on macOS.
     * [Pull Request 477](https://github.com/gazebosim/gz-sim/pull/477)
 
 1. Add support for topic statistics on breadcrumb deployments.
@@ -2064,7 +2064,7 @@
 1. Hello world plugin added
     * [Pull request #699](https://github.com/gazebosim/gz-sim/pull/699)
 
-1. Model info CLI `ign model`
+1. Model info CLI `gz model`
     * [Pull request #893](https://github.com/gazebosim/gz-sim/pull/893)
 
 1. Don't create components for entities that don't exist
@@ -2166,7 +2166,7 @@
 1. Added screenshot to toolbar
     * [Pull request #588](https://github.com/gazebosim/gz-sim/pull/588)
 
-1. Improve ign tool support on macOS
+1. Improve gz tool support on macOS
     * [Pull request #477](https://github.com/gazebosim/gz-sim/pull/477)
 
 1. change nullptr to a int ptr for qt 5.15.2 bug
@@ -2444,7 +2444,7 @@
     * [Pull Request 351](https://github.com/gazebosim/gz-sim/pull/351)
     * [Pull Request 362](https://github.com/gazebosim/gz-sim/pull/362)
 
-1. Tests & Warnings: Qt 5.14, breadcrumbs, Gui, ign_TEST
+1. Tests & Warnings: Qt 5.14, breadcrumbs, Gui, gz_TEST
     * [Pull Request 327](https://github.com/gazebosim/gz-sim/pull/327)
 
 1. Added support for specifying topics to record.
@@ -2585,7 +2585,7 @@
 1. Enhanced log playback performance.
     * [Pull Request 351](https://github.com/gazebosim/gz-sim/pull/351)
 
-1. Tests & Warnings: Qt 5.14, breadcrumbs, Gui, ign_TEST
+1. Tests & Warnings: Qt 5.14, breadcrumbs, Gui, gz_TEST
     * [Pull Request 327](https://github.com/gazebosim/gz-sim/pull/327)
 
 1. Added support for specifying topics to record.

Migration.md

@@ -31,6 +31,8 @@ release will remove the deprecated code.
   * `IGN_GAZEBO_PLUGIN_INSTALL_DIR`
   * `IGN_GAZEBO_GUI_PLUGIN_INSTALL_DIR`
   * `IGN_GAZEBO_WORLD_INSTALL_DIR`
+* The `gazebo` command line verb is deprecated.
+  Use `sim` instead (e.g. `ign gazebo` -> `gz sim`).
 
 ## Gazebo Sim 6.1 to 6.2
 
@@ -190,7 +192,7 @@ in SDF by setting the `<visual><material><double_sided>` SDF element.
   file can now be loaded without a flag.
 
 * The `ign-gazebo` command line tool is deprecated. The new tool is
-  `ign gazebo`, which has all the same options, except for
+  `gz sim`, which has all the same options, except for
   `--distributed` and `--file`/`-f`, which have been removed.
 
 * The `entity_name` field in the messages published by the imu system is
@@ -211,5 +213,5 @@ added an SDF message to the start of log files.
 * The ignition-gazebo1-gui library has been changed to a `gui` component of
 ignition-gazebo. To use the gui component downstream, update the find package
 call in cmake to request for the component, e.g.
-`ign_find_package(ignition-gazebo1 REQUIRED COMPONENTS gui)`, and link to the
+`gz_find_package(ignition-gazebo1 REQUIRED COMPONENTS gui)`, and link to the
 `libignition-gazebo1::gui` target instead of `libignition-gazebo1-gui`

README.md

@@ -85,13 +85,13 @@ See the [installation tutorial](https://gazebosim.org/api/gazebo/6.1/install.htm
 Gazebo Sim can be run from the command line, once [installed](#install), using:
 
 ```
-ign gazebo
+gz sim
 ```
 
 For help, and command line options use:
 
 ```
-ign gazebo -h
+gz sim -h
 ```
 
 ## Known issue of command line tools
@@ -103,7 +103,7 @@ A workaround for a single package is to define the environment variable
 `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/ignition
+export GZ_CONFIG_PATH=/usr/local/share/gz
 ```
 
 However, that environment variable only takes a single path, which means if the
@@ -114,9 +114,9 @@ line is using symbolic links to each library's YAML file.
 ```
 mkdir ~/.gz/tools/configs -p
 cd ~/.gz/tools/configs/
-ln -s /usr/local/share/ignition/fuel8.yaml .
-ln -s /usr/local/share/ignition/transport12.yaml .
-ln -s /usr/local/share/ignition/transportlog12.yaml .
+ln -s /usr/local/share/gz/fuel8.yaml .
+ln -s /usr/local/share/gz/transport12.yaml .
+ln -s /usr/local/share/gz/transportlog12.yaml .
 ...
 export GZ_CONFIG_PATH=$HOME/.gz/tools/configs
 ```

examples/plugin/command_actor/README.md

@@ -27,5 +27,5 @@ export GZ_SIM_SYSTEM_PLUGIN_PATH=`pwd`/build
 
 Then run the demo world:
 
-    ign gazebo -v 4 command_actor.sdf -r
+    gz sim -v 4 command_actor.sdf -r
 

examples/plugin/custom_component/README.md

@@ -29,5 +29,5 @@ export GZ_SIM_SYSTEM_PLUGIN_PATH=`pwd`/build
 
 Then run a world that loads the plugin as follows:
 
-    ign gazebo -s -v 4 custom_component.sdf
+    gz sim -s -v 4 custom_component.sdf
 

examples/plugin/custom_sensor_system/README.md

@@ -33,13 +33,13 @@ export GZ_SIM_SYSTEM_PLUGIN_PATH=`pwd`/build
 
 Then load the example world:
 
-    ign gazebo -r odometer.sdf
+    gz sim -r odometer.sdf
 
 You should see a box slowly moving in a straight line.
 
 Listen to the odometer data with:
 
 ```
-ign topic -e -t /world/odometer_world/model/model_with_sensor/link/link/sensor/an_odometer/odometer
+gz topic -e -t /world/odometer_world/model/model_with_sensor/link/link/sensor/an_odometer/odometer
 ```
 

examples/plugin/gui_system_plugin/README.md

@@ -34,7 +34,7 @@ export IGN_GUI_PLUGIN_PATH=`pwd`/build
 
 Then run a world, for example:
 
-    ign gazebo -v 4 shapes.sdf
+    gz sim -v 4 shapes.sdf
 
 From the GUI plugin menu on the top-right, choose "Gui System Plugin".
 

examples/plugin/hello_world/HelloWorld.cc

@@ -48,7 +48,7 @@ void HelloWorld::PostUpdate(const gz::sim::UpdateInfo &_info,
   msg += "paused.";
 
   // Messages printed with gzmsg only show when running with verbosity 3 or
-  // higher (i.e. ign gazebo -v 3)
+  // higher (i.e. gz sim -v 3)
   gzmsg << msg << std::endl;
 }
 

examples/plugin/hello_world/README.md

@@ -31,7 +31,7 @@ export GZ_SIM_SYSTEM_PLUGIN_PATH=`pwd`/build
 
 Then load the example world:
 
-    ign gazebo -v 3 hello_world_plugin.sdf
+    gz sim -v 3 hello_world_plugin.sdf
 
 You should see green messages on the terminal like: