Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ign -> gz Partial Docs Migration and Project Name Followups : gz-launch #173

Merged
merged 5 commits into from
Jun 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ gz_configure_project(
# Set project-specific options
#============================================================================

set(GZ_LAUNCH_PLUGIN_INSTALL_PATH "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/ign-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins/")
set(GZ_LAUNCH_PLUGIN_INSTALL_PATH "${CMAKE_INSTALL_PREFIX}/${IGN_LIB_INSTALL_DIR}/gz-${IGN_DESIGNATION}-${PROJECT_VERSION_MAJOR}/plugins/")

#============================================================================
# Search for project-specific dependencies
Expand Down Expand Up @@ -135,6 +135,6 @@ gz_create_docs(
"${GZ-TRANSPORT_DOXYGEN_TAGFILE} = ${GZ-TRANSPORT_API_URL}"
"${GZ-SENSORS_DOXYGEN_TAGFILE} = ${GZ-SENSORS_API_URL}"
"${GZ-COMMON_DOXYGEN_TAGFILE} = ${GZ-COMMON_API_URL}"
"${GZ-GAZEBO_DOXYGEN_TAGFILE} = ${GZ-GAZEBO_API_URL}"
"${GZ-SIM_DOXYGEN_TAGFILE} = ${GZ-SIM_API_URL}"
"${GZ-GUI_DOXYGEN_TAGFILE} = ${GZ-GUI_API_URL}"
)
24 changes: 12 additions & 12 deletions Changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
### Gazebo Launch 5.X.X (20XX-XX-XX)

### Gazebo Launch 5.1.0 (2022-03-21)
1. Use exec instead of popen to run ign-launch binary
1. Use exec instead of popen to run gz-launch binary
* [Pull request #151](https://github.com/gazebosim/gz-launch/pull/151)

1. Expose headless_rendering sdf tag
Expand All @@ -18,7 +18,7 @@

### Gazebo Launch 5.0.0 (2021-10-01)

1. Port ign-launch to Windows
1. Port gz-launch to Windows
* [Pull request #120](https://github.com/gazebosim/gz-launch/pull/120)

1. Add standalone executables
Expand All @@ -45,16 +45,16 @@

### Gazebo Launch 4.0.0 (2021-03-30)

1. Bump in edifice: ign-common4
1. Bump in edifice: gz-common4
* [Pull request #90](https://github.com/gazebosim/gz-launch/pull/90)

1. Bump in edifice: sdformat11
* [Pull request #87](https://github.com/gazebosim/gz-launch/pull/87)

1. Bump in edifice: ign-msgs7
1. Bump in edifice: gz-msgs7
* [Pull request #86](https://github.com/gazebosim/gz-launch/pull/86)

1. Bump in edifice: ign-rendering5
1. Bump in edifice: gz-rendering5
* [Pull request #69](https://github.com/gazebosim/gz-launch/pull/69)

## Gazebo Launch 3.x
Expand Down Expand Up @@ -116,13 +116,13 @@
* [Pull request 16](https://github.com/gazebosim/gz-launch/pull/16)
* [Pull request 28](https://github.com/gazebosim/gz-launch/pull/28)

1. Add PKGCONFIG information to ignition-tools gz_find_package
1. Add PKGCONFIG information to gz-tools gz_find_package
* [Pull request 44](https://github.com/gazebosim/gz-launch/pull/44)

1. Depend on ign-msgs6, ign-transport9
1. Depend on gz-msgs6, gz-transport9
* [Pull request 39](https://github.com/gazebosim/gz-launch/pull/39)

1. Depend on ign-gazebo4, ign-gui4
1. Depend on gz-sim4, gz-gui4
* [BitBucket pull request 64](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-launch/pull-requests/64)

## Gazebo Launch 2.x
Expand Down Expand Up @@ -159,7 +159,7 @@

### Gazebo Launch 2.1.0 (2020-05-21)

1. Merged ign-launch1 forward.
1. Merged gz-launch1 forward.
* [Pull request 41](https://github.com/gazebosim/gz-launch/pull/31)

### Gazebo Launch 2.0.0
Expand All @@ -184,7 +184,7 @@
* Modernize Github Actions CI.
* [Pull request 42](https://github.com/gazebosim/gz-launch/pull/42)

1. Add PKGCONFIG information to ignition-tools gz_find_package
1. Add PKGCONFIG information to gz-tools gz_find_package
* [Pull Request 44](https://github.com/gazebosim/gz-launch/pull/44)

1. Fix factory.gz launch file
Expand Down Expand Up @@ -239,7 +239,7 @@

### Gazebo Launch 1.4.2 (2020-05-18)

1. Use the new GUI API of ign-gazebo. This adds support for saving worlds to SDFormat from the GUI.
1. Use the new GUI API of gz-sim. This adds support for saving worlds to SDFormat from the GUI.
* [Pull Request 19](https://github.com/gazebosim/gz-launch/pull/19)

### Gazebo Launch 1.4.1 (2019-12-05)
Expand All @@ -257,7 +257,7 @@
1. Add filepath to ERB so that constants like `__FILE__` in `.ign` files work as expected
* [BitBucket pull request 48](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-launch/pull-requests/48)

1. Add backward support to ign-launch to capture backtraces.
1. Add backward support to gz-launch to capture backtraces.
* [BitBucket pull request 41](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-launch/pull-requests/41)

### Gazebo Launch 1.2.3 (2019-09-09)
Expand Down
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_launch-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_launch-ci-main-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/job/ign_launch-ign-5-win/badge/icon)](https://build.osrfoundation.org/job/ign_launch-ign-5-win/)

Gazebo Launch, a component of [Ignition
Robotics](https://gazebosim.org), provides a command line interface
Gazebo Launch, a component of [Gazebo](https://gazebosim.org), provides a command line interface
to run and manager application and plugins.

# Table of Contents
Expand Down Expand Up @@ -72,10 +71,10 @@ Sample launch configuration files are in the [examples directory](https://github
## 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
Expand All @@ -84,7 +83,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
Expand All @@ -107,7 +106,7 @@ See the [installation tutorial](https://gazebosim.org/api/launch/5.0/install.htm
Refer to the following table for information about important directories and files in this repository.

```
ign-launch
gz-launch
├── examples Example launch configurations.
├── include/ignition/launch Header files.
├── plugins Launch plugins, one per subdirectory.
Expand Down
4 changes: 2 additions & 2 deletions api.md.in
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion examples/gazebo_plugins.ign
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
end
%>

<!-- Requires ign-gazebo branch support_loading_plugins_programmatically -->
<!-- Requires gz-sim branch support_loading_plugins_programmatically -->
<ignition version='1.0'>
<!-- Load a joystick plugin that will read from a device and output to a
topic -->
Expand Down
8 changes: 4 additions & 4 deletions plugins/websocket_server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

1. [Install gz-acropolis](https://gazebosim.org/docs/acropolis/install).

2. Compile and install ign-launch from source. You will have to `sudo make
install` so that `ign-tools` find the launch.yaml files.
2. Compile and install gz-launch from source. You will have to `sudo make
install` so that `gz-tools` find the launch.yaml files.

```
sudo apt-get install libwebsockets-dev
Expand All @@ -14,10 +14,10 @@ make
sudo make install
```

3. Run ign-gazebo.
3. Run gz-sim.

```
ign-gazebo -v 4
gz sim -v 4
```

4. Run the websocket server. The follow assumes you are in the root of the
Expand Down
6 changes: 3 additions & 3 deletions tutorials.md.in
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
\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.

**Tutorials**

1. \subpage basics "Ignition launch tutorial"
1. \subpage basics "Gazebo launch tutorial"
1. \subpage install "Install instructions"

## License
Expand Down
14 changes: 7 additions & 7 deletions tutorials/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
# Install

These instructions are for installing only Gazebo Launch. If you're interested
in using all the Ignition libraries, not only Igniton Launch, check out this
[Ignition installation](https://gazebosim.org/docs/latest/install).
in using all the Gazebo libraries, not only Igniton Launch, check out this
[Gazebo installation](https://gazebosim.org/docs/latest/install).

We recommend following the binary install instructions to get up and running as
quickly and painlessly as possible.
Expand All @@ -21,7 +21,7 @@ The [Source Install](#source-install) instructions should be used if you need th

## Ubuntu 20.04 or above

On Ubuntu systems, `apt` can be used to install `ignition-launch`:
On Ubuntu systems, `apt` can be used to install `gz-launch`:

```
sudo apt install libignition-launch<#>
Expand Down Expand Up @@ -65,7 +65,7 @@ necessary prerequisites followed by building from source.
$(sort -u $(find . -iname 'packages-'`lsb_release -cs`'.apt' -o -iname 'packages.apt' | grep -v '/\.git/') | sed '/ignition\|sdf/d' | tr '\n' ' ')
```

1. Install required Ignition libraries
1. Install required Gazebo libraries

```sh
sudo sh -c 'echo "deb http://packages.osrfoundation.org/gazebo/ubuntu-stable `lsb_release -cs` main" > /etc/apt/sources.list.d/gazebo-stable.list'
Expand All @@ -85,7 +85,7 @@ necessary prerequisites followed by building from source.
2. Configure and build

```sh
cd ign-launch; mkdir build; cd build; cmake ..; make
cd gz-launch; mkdir build; cd build; cmake ..; make
```

3. Optionally, install Gazebo Launch
Expand All @@ -112,7 +112,7 @@ necessary prerequisites followed by building from source.

3. Configure and build
```
cd ign-launch
cd gz-launch
mkdir build
cd build
cmake ..
Expand Down Expand Up @@ -145,7 +145,7 @@ You can also generate the documentation from a clone of this repository by follo
3. Configure and build the documentation.

```
cd ign-launch; mkdir build; cd build; cmake ../; make doc
cd gz-launch; mkdir build; cd build; cmake ../; make doc
```

4. View the documentation by running the following command from the build directory.
Expand Down
2 changes: 1 addition & 1 deletion tutorials/tutorial.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
\page basics Ignition launch tutorial
\page basics Gazebo launch tutorial

Gazebo Launch is used to run and manage plugins and programs. A configuration script can be used to specify which programs and plugins to execute. Alternatively, individual programs and plugins can be run from the command line.

Expand Down