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

…sport (#325)

Changelog.md

@@ -12,7 +12,7 @@
 1. Remove unnecessary copy and assignment operators
     * [Pull request #240](https://github.com/gazebosim/gz-transport/pull/240)
 
-1. Depend on ign-msgs8
+1. Depend on gz-msgs8
     * [Pull request #238](https://github.com/gazebosim/gz-transport/pull/238)
 
 1. Infrastructure
@@ -25,7 +25,7 @@
 
 ### Gazebo Transport 10.2.0 (2022-03-25)
 
-1. Use exec instead of popen to run ign-launch binary
+1. Use exec instead of popen to run gz-launch binary
     * [Pull request #300](https://github.com/gazebosim/gz-transport/pull/300)
 
 1. Focal CI: static checkers, doxygen linters, compiler warnings
@@ -74,7 +74,7 @@
 1. Add instructions to build and run examples
     * [Pull request #222](https://github.com/gazebosim/gz-transport/pull/222)
 
-1. Bump in edifice: ign-msgs7
+1. Bump in edifice: gz-msgs7
     * [Pull request #213](https://github.com/gazebosim/gz-transport/pull/213)
 
 1. Configurable IP address and port for discovery
@@ -503,7 +503,7 @@
 1. Basic authentication for topics.
     * [BitBucket pull request 236](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/236)
 
-1. Upgrade to ign-cmake.
+1. Upgrade to gz-cmake.
     * [BitBucket pull request 239](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/239)
 
 1. Added a benchmark program to test latency and throughput.

INSTALL_WINDOWS.md

@@ -47,7 +47,7 @@ directory that has the source files. Here is an example:
 1. Clone and prepare the Gazebo Math dependency:
 
         git clone https://github.com/gazebosim/gz-math
-        cd ign-math
+        cd gz-math
         mkdir build
 
 1. In a Windows Command Prompt, load your compiler setup, e.g.:
@@ -56,31 +56,31 @@ directory that has the source files. Here is an example:
 
 1. In the Windows Command Promp, configure and build:
 
-        cd ign-math\build
+        cd gz-math\build
         ..\configure
         nmake install
 
 1. Clone and prepare the Gazebo Msgs dependency:
 
         git clone https://github.com/gazebosim/gz-msgs
-        cd ign-msgs
+        cd gz-msgs
         mkdir build
 
 1. In the Windows Command Prompt, configure and build:
 
-        cd ign-msgs\build
+        cd gz-msgs\build
         ..\configure
         nmake install
 
 1. Clone ign-transport:
 
         git clone https://github.com/gazebosim/gz-transport
-        cd ign-transport
+        cd gz-transport
         mkdir build
 
 1. In the Windows Command Prompt, configure and build:
 
-	    cd ign-transport\build
+	    cd gz-transport\build
         ..\configure
         nmake install
 
@@ -117,5 +117,5 @@ if it contains spaces.  E.g., if you're working in `C:\My Stuff\gz-ws`:
 
 1. In the Windows Command Prompt, run the test suite:
 
-    cd ign-transport\build
+    cd gz-transport\build
     ctest

Migration.md

@@ -36,11 +36,20 @@ release will remove the deprecated code.
      1. `IGN_CPPZMQ_POST_4_7_0`
      1. `ign_strcat`, `ign_strcpy`, `ign_sprintf`, `ign_strdup`
 
+### 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
+
 ## Gazebo Transport 9.X to 10.X
 
 ### Addition
 
-1. Dependency on `cli` component of `ignition-utils`.
+1. Dependency on `cli` component of `gz-utils`.
     * [GitHub pull request 229](https://github.com/gazebosim/gz-transport/pull/229)
 
 ## Gazebo Transport 8.X to 9.X
@@ -60,7 +69,7 @@ release will remove the deprecated code.
 1. The discovery wire protocol changed to use gz::msgs::Discovery
    instead of C-structs. The Packet.hh header file is deprecated, which
    contained the Header, SubscriptionMsg, and AdvertiseMessage classes. The
-   version of the wire protocal has bumped from 9 to 10. This means Ignition
+   version of the wire protocal has bumped from 9 to 10. This means Gazebo
    Transport 8+ will not work with Gazebo Transport 7 and below.
     * [BitBucket pull request 403](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/403)
 

README.md

@@ -66,10 +66,10 @@ in the source code.
 ## 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 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

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

docker/ign-transport/Dockerfile

@@ -72,15 +72,15 @@ RUN sudo /bin/sh -c 'echo "deb [trusted=yes] http://packages.osrfoundation.org/g
 
 # Ignition transport
 RUN git clone https://github.com/gazebosim/gz-transport.git \
- && cd ign-transport \
+ && cd gz-transport \
  && mkdir build \
  && cd build \
  && cmake .. -DCMAKE_INSTALL_PREFIX=/usr \
  && sudo make -j4 install \
  && cd ../..
 
 # Ignition transport examples
-RUN cd ign-transport/example \
+RUN cd gz-transport/example \
  && mkdir build \
  && cd build \
  && cmake .. \

example/CMakeLists.txt

@@ -2,7 +2,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR)
 
 project(gz-transport-examples)
 
-# Find the Ignition_Transport library
+# Find the Gazebo Transport library
 find_package(gz-transport12 QUIET REQUIRED OPTIONAL_COMPONENTS log)
 set(GZ_TRANSPORT_VER ${gz-transport12_VERSION_MAJOR})
 

example/README.md

@@ -25,7 +25,7 @@ Build on Unix:
 make
 ```
 
-To build on Windows, make sure the configuration matches `ign-transport`'s 
+To build on Windows, make sure the configuration matches `gz-transport`'s 
 configuration:
 
 ```

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

tutorials/01_intro.md

@@ -4,7 +4,7 @@ Next Tutorial: \ref installation
 
 ## What is Gazebo Transport?
 
-Ignition Transport is an open source communication library that allows sharing
+Gazebo Transport is an open source communication library that allows sharing
 data between clients. In our context, a client is called a node. Nodes might
 be running within the same process on the same machine or on separate machines located
 around the world. Gazebo Transport is multi-platform (Linux, Mac OS X, and

tutorials/02_installation.md

@@ -104,7 +104,7 @@ git clone https://github.com/gazebosim/gz-transport
 
 Configure and build
 ```
-cd ign-common
+cd gz-common
 mkdir build
 cd build
 cmake ..
@@ -125,7 +125,7 @@ between source and debian installs:
 cmake -DCMAKE_INSTALL_PREFIX=/home/$USER/local ..
 ```
 
-B. Debug mode: This will generate code with debug symbols. Ignition
+B. Debug mode: This will generate code with debug symbols. Gazebo
 Transport will run slower, but you'll be able to use GDB.
 ```
 cmake -DCMAKE_BUILD_TYPE=Debug ..
@@ -188,7 +188,7 @@ sudo make uninstall
 
 3. Configure and build
   ```
-  cd ign-transport
+  cd gz-transport
   mkdir build
   cd build
   cmake ..
@@ -204,7 +204,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`).
 
@@ -218,7 +218,7 @@ Install prerequisites:
 conda install zeromq cppzmq --channel conda-forge
 ```
 
-Install Ignition dependencies:
+Install Gazebo dependencies:
 
 You can view available versions and their dependencies:
 ```
@@ -240,7 +240,7 @@ conda install libignition-cmake<#> libignition-msgs<#> libignition-tools<#> --ch
 
 2. Configure and build
   ```
-  cd ign-transport
+  cd gz-transport
   mkdir build
   cd build
   cmake .. -DBUILD_TESTING=OFF  # Optionally, -DCMAKE_INSTALL_PREFIX=path\to\install
@@ -257,7 +257,7 @@ conda install libignition-cmake<#> libignition-msgs<#> libignition-tools<#> --ch
   If you installed to a custom location, you may need to specify ``-DCMAKE_PREFIX_PATH``, pointing to the directory containing the file ``gz-transport<#>-config.cmake``.
   That file is installed to the ``CMAKE_INSTALL_PREFIX``, for example, ``path\to\install\gz-transport<#>\lib\cmake\gz-transport<#>``.
   ```
-  cd ign-transport\example
+  cd gz-transport\example
   mkdir build
   cd build
   cmake ..  # Optionally, -DCMAKE_PREFIX_PATH=path\to\cmake\config

tutorials/04_messages.md

@@ -85,7 +85,7 @@ int main(int argc, char **argv)
 #include <gz/transport.hh>
 ```
 
-The line `#include <gz/transport.hh>` contains all the Ignition
+The line `#include <gz/transport.hh>` contains all the Gazebo
 Transport headers for using the transport library.
 
 The next line includes the generated protobuf code that we are going to use

tutorials/06_security.md

@@ -38,7 +38,7 @@ password. Also, every subscriber will only connect to secure publishers.
 ### Example
 
 First, let's test unsecure communication. This example requires
-[ign-tools](https://github.com/gazebosim/gz-tools).
+[gz-tools](https://github.com/gazebosim/gz-tools).
 
 1. Open a terminal, and echo topic `/foo`.
 ```

tutorials/07_relay.md

@@ -14,8 +14,8 @@ simulate this configuration, and then we'll enable the relay capabilities of
 Gazebo Transport to make the communication possible.
 
 ```{.sh}
-mkdir -p ~/ign_transport_tutorial/docker/ign-transport
-cd ~/ign_transport_tutorial/docker
+mkdir -p ~/gz_transport_tutorial/docker/gz-transport
+cd ~/gz_transport_tutorial/docker
 ```
 
 ## Setup
@@ -31,23 +31,23 @@ Download the [build.bash](https://github.com/gazebosim/gz-transport/raw/main/doc
 ```{.sh}
 wget https://github.com/gazebosim/gz-transport/raw/main/docker/build.bash
 wget https://github.com/gazebosim/gz-transport/raw/main/docker/run.bash
-wget https://github.com/gazebosim/gz-transport/raw/main/docker/ign-transport/Dockerfile -O ign-transport/Dockerfile
+wget https://github.com/gazebosim/gz-transport/raw/main/docker/ign-transport/Dockerfile -O gz-transport/Dockerfile
 chmod +x build.bash run.bash
 ```
 
 Now, it's time to build the Docker image:
 ```
-./build.bash ign-transport
+./build.bash gz-transport
 ```
 
 Run your Docker container:
 ```
-./run.bash ign-transport
+./run.bash gz-transport
 ```
 
 Inside the docker instance, go to the `example` directory:
 ```
-cd ign-transport/example/build
+cd gz-transport/example/build
 ```
 
 Back on your host, make sure that you have Gazebo Tools and net-tools
@@ -60,7 +60,7 @@ Now, let's configure Gazebo Transport to block all multicast traffic going
 into your Docker instance. Run the command `ifconfig` to list your network
 interfaces:
 ```
-caguero@bb9:~/ign_transport_tutorial/docker$ ifconfig
+caguero@bb9:~/gz_transport_tutorial/docker$ ifconfig
 docker0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
         inet 172.17.0.1  netmask 255.255.0.0  broadcast 172.17.255.255
         inet6 fe80::42:73ff:fe1c:351e  prefixlen 64  scopeid 0x20<link>
@@ -105,7 +105,7 @@ GZ_PARTITION=relay ./publisher
 
 ## Launch the subscriber
 
-Open a terminal in your host and launch your subscriber, forcing Ignition
+Open a terminal in your host and launch your subscriber, forcing Gazebo
 Transport to only bind to the IP address that we found in the previous step:
 
 ```
@@ -120,7 +120,7 @@ Docker container. For that purpose, you'll need to know the IP address used
 in your Docker container. Run the `ifconfig` command inside your Docker
 instance:
 ```
-developer@b98e0f32f32f:~/ign-transport/example/build$ ifconfig
+developer@b98e0f32f32f:~/gz-transport/example/build$ ifconfig
 eth0: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
         inet 172.17.0.3  netmask 255.255.0.0  broadcast 172.17.255.255
         ether 02:42:ac:11:00:03  txqueuelen 0  (Ethernet)

tutorials/20_env_variables.md

@@ -27,7 +27,7 @@ Below are descriptions of the available environment variables:
 * **GZ_IP**
     * *Value allowed*: Any local IP address
     * *Description*: When you have
-    multiple IP addresses for a computer and need to force Ignition
+    multiple IP addresses for a computer and need to force Gazebo
     Transport to use a particular one. This setting is only required if you
     advertise a topic or a service. If you are only subscribed to topics or
     requesting services you don't need to use this option because the

tutorials/22_development.md

@@ -5,7 +5,7 @@ Previous Tutorial: \ref envvars
 
 ## Overview
 
-The purpose of this section is to describe the internal design of Ignition
+The purpose of this section is to describe the internal design of Gazebo
 Transport. You don't need to read this section if you just want to use the
 library in your code. This section will help you to understand our source code
 if you're interested in making code contributions.