[ign ➡️ gz] Logo, docs, tools

Signed-off-by: Louise Poubel <[email protected]>
gazebosim · chapulina · Jun 6, 2022 · Jun 3, 2022 · Jun 3, 2022 · Jun 6, 2022
commit 696b204a880850269ffc51c272b0142752f17944
@@ -228,8  228,8 @@ endif()
 #============================================================================
 configure_file(${CMAKE_SOURCE_DIR}/api.md.in ${CMAKE_BINARY_DIR}/api.md)
 configure_file(${CMAKE_SOURCE_DIR}/tutorials.md.in ${CMAKE_BINARY_DIR}/tutorials.md)
-configure_file(${CMAKE_SOURCE_DIR}/tools/desktop/ignition-gazebo.desktop.in ${CMAKE_BINARY_DIR}/ignition-gazebo${PROJECT_VERSION_MAJOR}.desktop)
-configure_file(${CMAKE_SOURCE_DIR}/tools/desktop/ignition-gazebo.svg.in ${CMAKE_BINARY_DIR}/ignition-gazebo${PROJECT_VERSION_MAJOR}.svg)
 configure_file(${CMAKE_SOURCE_DIR}/tools/desktop/gz-sim.desktop.in ${CMAKE_BINARY_DIR}/gz-sim${PROJECT_VERSION_MAJOR}.desktop)
 configure_file(${CMAKE_SOURCE_DIR}/tools/desktop/gz-logo.svg.in ${CMAKE_BINARY_DIR}/gz-logo${PROJECT_VERSION_MAJOR}.svg)
 
 # disable doxygen on macOS due to issues with doxygen 1.9.0
 # there is an unreleased fix; revert this when 1.9.1 is released

@@ -473,7  473,7 @@
     * [Pull request #1067](https://github.com/gazebosim/gz-sim/pull/1067)
     * [Pull request #1064](https://github.com/gazebosim/gz-sim/pull/1064)
 
-1. Fix non desired window opening alongside ignition GUI
 1. Fix non desired window opening alongside Gazebo GUI
     * [Pull request #1063](https://github.com/gazebosim/gz-sim/pull/1063)
 
 1. Documentation
@@ -538,7  538,7 @@
 1. Add a flag to force headless rendering mode
     * [Pull request #701](https://github.com/gazebosim/gz-sim/pull/701)
 
-1. Remove unused ignition gui header
 1. Remove unused Gazebo GUI header
     * [Pull request #1026](https://github.com/gazebosim/gz-sim/pull/1026)
 
 1. Adds velocity control to JointPositionController.
@@ -851,7  851,7 @@
 1. bump version and update changelog
     * [Pull request #1029](https://github.com/gazebosim/gz-sim/pull/1029)
 
-1. Remove unused ignition gui header
 1. Remove unused Gazebo GUI header
     * [Pull request #1026](https://github.com/gazebosim/gz-sim/pull/1026)
 
 1. Collada world exporter now exporting lights
@@ -3297,7  3297,7 @@
 1. Add systems to queue before actually adding them to runner
     * [BitBucket pull request 241](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gazebo/pull-requests/241)
 
-1. Added a docker image that uses the ignition meta package
 1. Added a docker image that uses the Gazebo meta package
     * [BitBucket pull request 237](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gazebo/pull-requests/237)
 
 1. Move some design docs to tutorials

@@ -69,7  69,7 @@ accurate models available through
 [Gazebo Fuel](https://app.gazebosim.org/fuel). You can also build a
 new model using [SDF](http://sdformat.org).
 
-* **TCP/IP Transport**: Run simulation on remote servers and interface to Ignition
 * **TCP/IP Transport**: Run simulation on remote servers and interface to
 Gazebo Sim through socket-based message passing using
 [Gazebo Transport](https://github.com/gazebosim/gz-transport).
 
@@ -100,7  100,7 @@ In the event that the installation is a mix of Debian and from source, command
 line tools from `ign-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/ignition
@@ -109,7  109,7 @@ export GZ_CONFIG_PATH=/usr/local/share/ignition
 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 ~/.gz/tools/configs -p

@@ -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. 
 
 **Useful links**

@@ -5,8  5,8 @@ RUN apt-get update \
       sudo wget lsb-release gnupg curl \
  && apt-get clean
 
-COPY docker/scripts/enable_ign_stable.sh scripts/enable_ign_stable.sh
-RUN scripts/enable_ign_stable.sh
 COPY docker/scripts/enable_stable.sh scripts/enable_stable.sh
 RUN scripts/enable_stable.sh
 
 COPY docker/scripts/install_common_deps.sh scripts/install_common_deps.sh
 RUN scripts/install_common_deps.sh

@@ -1,13  1,13 @@
 # Purpose
 #
 #   This docker file is used by build.bash and run.bash to build and run
-#   an Ignition distribution based on binaries. See the README.md file.
 #   an Gazebo distribution based on binaries. See the README.md file.
 
 # Ubuntu 20.04 with nvidia opengl support
 FROM nvidia/opengl:1.2-glvnd-devel-ubuntu20.04
 
-# Name of the Ignition distribution
-ARG ign_distribution
 # Name of the Gazebo distribution
 ARG gz_distribution
 
 # Tools I find useful during development
 RUN apt-get update \
@@ -46,7  46,7 @@ RUN sudo /bin/sh -c 'echo "deb [trusted=yes] http://packages.osrfoundation.org/g
  && sudo /bin/sh -c 'apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-key 421C365BD9FF1F717815A3895523BAEEB01FA116' \
  && sudo apt-get update \
  && sudo apt-get install -y \
-    ${ign_distribution} \
     ${gz_distribution} \
  && sudo apt-get clean
 
-ENTRYPOINT ["ign-gazebo"]
 ENTRYPOINT ["gz-sim"]
@@ -1,13  1,13 @@
-FROM ign-gazebo:base
 FROM gz-sim:base
 
-COPY docker/scripts/enable_ign_stable.sh scripts/enable_ign_stable.sh
-RUN scripts/enable_ign_stable.sh
 COPY docker/scripts/enable_stable.sh scripts/enable_stable.sh
 RUN scripts/enable_stable.sh
 
-COPY docker/scripts/enable_ign_prerelease.sh scripts/enable_ign_prerelease.sh
-RUN scripts/enable_ign_prerelease.sh
 COPY docker/scripts/enable_prerelease.sh scripts/enable_prerelease.sh
 RUN scripts/enable_prerelease.sh
 
-COPY docker/scripts/enable_ign_nightly.sh scripts/enable_ign_nightly.sh
-RUN scripts/enable_ign_nightly.sh
 COPY docker/scripts/enable_nightly.sh scripts/enable_nightly.sh
 RUN scripts/enable_nightly.sh
 
 RUN apt-get update \
  && apt-get install -y \
@@ -25,9  25,9 @@ RUN apt-get update \
     libignition-sensors7-dev \
     libsdformat13-dev
 
-COPY . ign-gazebo
-RUN cd ign-gazebo \
- && ./docker/scripts/build_ign_gazebo.sh
 COPY . gz-sim
 RUN cd gz-sim \
  && ./docker/scripts/build_gz_sim.sh
 
 COPY ./docker/scripts/entrypoint.sh /
 ENTRYPOINT ["/entrypoint.sh"]
@@ -3,14  3,14 @@
 This directory contains a few Dockerfiles and supporting scripts. See each
 section below for usage information about
 
-1. [Dockerfile.ignition](#Gazebo-Sim-Using-Debians-In-Docker)
 1. [Dockerfile.gz](#Gazebo-Sim-Using-Debians-In-Docker)
 1. [Dockerfile.nightly](#Build-Gazebo-Sim-Using-Nightly-Debians)
 
 ## Build Gazebo Sim Using Nightly Debians
 
 This section describes how to build and run a docker image based on
 nightly builds of downstream
-[Ignition libraries](https://gazebosim.org/libs). The Docker image will
 [Gazebo libraries](https://gazebosim.org/libs). The Docker image will
 use the Gazebo code found in the current source tree.
 
 **Requirements**
@@ -34,30  34,30 @@ use the Gazebo code found in the current source tree.
 1. Build the gz-gazebo:base image.
 
     ```
-    docker build . -f ./docker/Dockerfile.base -t ign-gazebo:base
     docker build . -f ./docker/Dockerfile.base -t gz-sim:base
     ```
 
 2. Build the nightly docker image.
 
     ```
-    docker build . -f ./docker/Dockerfile.nightly -t ign-gazebo:nightly
     docker build . -f ./docker/Dockerfile.nightly -t gz-sim:nightly
     ```
 
 3. Run the docker image with a bash shell.
 
     ```
-    docker run -it ign-gazebo:nightly /bin/bash
     docker run -it gz-sim:nightly /bin/bash
     ```
 
 4. Alternatively, you can directly run Gazebo using
 
     ```
-    ./docker/run.bash ign-gazebo:nightly ign-gazebo-server -v 4
     ./docker/run.bash gz-sim:nightly ign-gazebo-server -v 4
     ```
 
 ## Gazebo Using Debians In Docker
 
-This section describes how to build and run a docker image of an Ignition
 This section describes how to build and run a docker image of an Gazebo
 distribution using debians.
 
 **Requirements**
@@ -69,11  69,11 @@ distribution using debians.
 **Steps**
 
 1. Build a docker image using the `build.bash` command. The first argument
-   must be the name of the Ignition distribution. The list of Ignition distribution can be found at [Ignition distribution](https://gazebosim.org/docs). For example, to build an
    must be the name of the Gazebo distribution. The list of Gazebo distribution can be found at [Gazebo distribution](https://gazebosim.org/docs). For example, to build an
    image of Gazebo Fortress:
 
     ```
-    ./build.bash ignition-garden ./Dockerfile.ignition
     ./build.bash ignition-garden ./Dockerfile.gz
     ```
 
 2. Run the docker image using `run.bash`, and pass in the name of the docker

@@ -1,13  1,13 @@
 #!/usr/bin/env bash
 #
 # Purpose
-#   This script is designed to build a docker image of an Ignition distribution.
 #   This script is designed to build a docker image of an Gazebo distribution.
 #   See README.md and run.bash for more information.
 
 if [ $# -eq 0 ]
 then
-    echo "Usage: $0 <Ignition meta-package name> <dockerfile>"
-    echo "Example: $0 ignition-blueprint ./Dockerfile.ignition"
     echo "Usage: $0 <Gazebo meta-package name> <dockerfile>"
     echo "Example: $0 ignition-blueprint ./Dockerfile.gz"
     exit 1
 fi
 
@@ -16,7  16,7 @@ image_name=$1
 dir_name=$(dirname $2)
 image_plus_tag=$image_name:$(date  %Y_%m_%d_%H%M)
 
-docker build --rm -t $image_plus_tag --build-arg user_id=$user_id --build-arg ign_distribution=$1 -f $2 .
 docker build --rm -t $image_plus_tag --build-arg user_id=$user_id --build-arg gz_distribution=$1 -f $2 .
 docker tag $image_plus_tag $image_name:latest
 
 echo "Built $image_plus_tag and tagged as $image_name:latest"
@@ -6,7  6,7 @@
 
 if [ $# -lt 1 ]
 then
-    echo "Usage: $0 <docker image> [optional arguments to ign-gazebo]"
     echo "Usage: $0 <docker image> [optional arguments to gz-sim]"
     exit 1
 fi
 

@@ -1,14  1,14 @@
 #!/bin/bash
 # Command line parameters:
 # 1 - github organization name. For example gazebosim or osrf.
-# 2 - the name of the ignition repository. For example ign-math.
-# 3 - the name of the branch. For example ign-math7
 # 2 - the name of the Gazebo repository. For example gz-math.
 # 3 - the name of the branch. For example gz-math7
 
 set -o errexit
 set -o verbose
 
 git clone https://github.com/$1/$2 -b $3
-cd $2 
 cd $2
 mkdir build
 cd build
 cmake ../ -DBUILD_TESTING=false

@@ -1,8  1,8 @@
 #!/bin/bash
 # Command line parameters:
 # 1 - github organization name. For example gazebosim or osrf.
-# 2 - the name of the ignition repository. For example ign-math.
-# 3 - the name of the branch. For example ign-math7
 # 2 - the name of the Gazebo repository. For example gz-math.
 # 3 - the name of the branch. For example gz-math7
 
 set -o errexit
 set -o verbose

@@ -3,7  3,7 @@
 This example shows how to create a GUI system plugin.
 
 Gazebo supports any kind of Gazebo GUI plugin
-(`gz::gui::Plugin`). Gazebo GUI plugins are a special type of Ignition
 (`gz::gui::Plugin`). Gazebo GUI plugins are a special type of Gazebo
 GUI plugin which also have access to entity and component updates coming from
 the server.
 

@@ -15,7  15,7 @@ From this directory, run the following to compile:
 
 ## Execute Instructions
 
-From the `build` directory, run Ignition and the example controller:
 From the `build` directory, run Gazebo Sim and the example controller:
 
     ign gazebo -r ../../../worlds/multi_lrauv_race.sdf
     ./multi_lrauv_race

@@ -290,7  290,7 @@ namespace gz
     /// \brief Specialized conversion from a steady clock duration to a time
     /// message.
     /// \param[in] _in Steady clock duration.
-    /// \return Ignition time message.
     /// \return Gazebo time message.
     template<>
     msgs::Time convert(const std::chrono::steady_clock::duration &_in);
 

@@ -21,8  21,7 @@
 #include <gz/sim/config.hh>
 #include <gz/sim/Export.hh>
 
-/// \brief This library is part of the [Ignition
-/// Robotics](https://gazebosim.org) project.
 /// \brief This library is part of the [Gazebo](https://gazebosim.org) project.
 namespace gz
 {
   /// \brief Gazebo is a leading open source robotics simulator, that

@@ -160,7  160,7 @@ namespace gz
     std::vector<std::string> GZ_GAZEBO_VISIBLE resourcePaths();
 
     /// \brief Add resource paths based on latest environment variables.
-    /// This will update the SDF and Ignition environment variables, and
     /// This will update the SDF and Gazebo environment variables, and
     /// optionally add more paths to the list.
     /// \param[in] _paths Optional paths to add.
     void GZ_GAZEBO_VISIBLE addResourcePaths(

@@ -46,7  46,7 @@ namespace sim
     Q_OBJECT
 
     /// \brief Update callback called every time the system is stepped.
-    /// This is called at an Ignition transport thread, so any interaction
     /// This is called at a Gazebo Transport thread, so any interaction
     /// with Qt should be done through signals and slots.
     /// \param[in] _info Current simulation information, such as time.
     /// \param[in] _ecm Mutable reference to the ECM, so the system can read

@@ -243,7  243,7 @@ inline namespace GZ_SIM_VERSION_NAMESPACE {
     public: rendering::ParticleEmitterPtr UpdateParticleEmitter(Entity _id,
         const msgs::ParticleEmitter &_emitter);
 
-    /// \brief Ignition sensors is the one responsible for adding sensors
     /// \brief Gazebo Sensors is the one responsible for adding sensors
     /// to the scene. Here we just keep track of it and make sure it has
     /// the correct parent.
     /// \param[in] _gazeboId Entity in Gazebo

@@ -267,7  267,7 @@ class ElementUpdateFixture : public InternalFixture<::testing::Test>
       return out;
     };
 
-    // Configure SDF to fetch assets from ignition fuel.
     // Configure SDF to fetch assets from Gazebo Fuel.
     sdf::setFindCallback(fuelCb);
     creator = std::make_unique<SdfEntityCreator>(this->ecm, this->evm);
   }

@@ -63,7  63,7 @@ Server::Server(const ServerConfig &_config)
     config.SetCacheLocation(_config.ResourceCache());
   this->dataPtr->fuelClient = std::make_unique<fuel_tools::FuelClient>(config);
 
-  // Configure SDF to fetch assets from ignition fuel.
   // Configure SDF to fetch assets from Gazebo Fuel.
   sdf::setFindCallback(std::bind(&ServerPrivate::FetchResource,
         this->dataPtr.get(), std::placeholders::_1));
   common::addFindFileURICallback(std::bind(&ServerPrivate::FetchResourceUri,

@@ -404,7  404,7 @@ void addResourcePaths(const std::vector<std::string> &_paths)
     sdfPaths = common::Split(sdfPathCStr, ':');
   }
 
-  // Ignition file paths (for <uri>s)
   // Gazebo file paths (for <uri>s)
   auto systemPaths = common::systemPaths();
   std::vector<std::string> ignPaths;
   char *ignPathCStr = std::getenv(systemPaths->FilePathEnv().c_str());

@@ -1,4  1,4 @@
---- # Subcommands available inside ignition gazebo
 --- # Subcommands available inside Gazebo Sim
 format: 1.0.0
 library_name: ignition-gazebo-ign
 library_version: @PROJECT_VERSION_FULL@
-Original file line number
+Diff line change
@@ Expand Up / @@ -6,7 6,7 @@ @@
     if [ $# -lt 1 ]
     then
-        echo "Usage: $0 <docker image> [optional arguments to ign-gazebo]"
+        echo "Usage: $0 <docker image> [optional arguments to gz-sim]"
         exit 1
     fi
@@ Expand Down @@