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 Namespace Migration : gz-transport #311

Merged
merged 28 commits into from
May 29, 2022
Merged
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
b7723c3
Update header guards
methylDragon May 18, 2022
481885c
Migrate namespaces
methylDragon May 18, 2022
2abe365
Add migration line
methylDragon May 18, 2022
9796364
Implement deprecation trick
methylDragon May 18, 2022
12e202b
Add deprecation test
methylDragon May 18, 2022
a8e9431
Include config.hh
methylDragon May 18, 2022
2ee6c0c
Use pragma deprecation message instead
methylDragon May 19, 2022
c315bb8
Ticktock config macros
methylDragon May 19, 2022
1546644
Fix migration
methylDragon May 19, 2022
7129e27
Migrate inline namespaces
methylDragon May 20, 2022
56c1ae6
Migrate includes to gz
methylDragon May 20, 2022
1e9b32d
Mention gz headers in migration
methylDragon May 20, 2022
6ebd9b9
Update config.hh
methylDragon May 20, 2022
3a68528
Migrate Export.hh macros and update deprecated test
methylDragon May 20, 2022
362c080
Support gz-msgs hard-tock and update more macros
methylDragon May 20, 2022
8363110
Migrate github links
methylDragon May 20, 2022
6989bf0
Migrate user-facing Ignition to Gazebo
methylDragon May 20, 2022
f0d3c02
Migrate "ignition.msgs" -> "gz.msgs"
methylDragon May 21, 2022
0fcf37e
Include config.hh in recursive directories and <lib>.hh
methylDragon May 22, 2022
f1a06af
Include config.hh in .h and .hpp redirection headers
methylDragon May 22, 2022
3de2277
`Gazebo Robotics` -> `Gazebo`
methylDragon May 23, 2022
de43793
`ignitionrobotics` -> `gazebosim`
methylDragon May 23, 2022
06a1686
Rollback osrf-migration.github.io migrations
methylDragon May 24, 2022
53f081c
Migrate Ignition's -> Gazebo's
methylDragon May 25, 2022
a5bfed8
Tick-tock IGN_TRANSPORT_LOG_SQL_PATH
methylDragon May 25, 2022
7887884
Wording changes
methylDragon May 25, 2022
2d73ee6
Tick-tock usage of GZ_TRANSPORT_LOG_SQL_PATH
methylDragon May 26, 2022
f4deacb
Fix linting errors
methylDragon May 29, 2022
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
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See the [Ignition Robotics contributing guide](https://ignitionrobotics.org/docs/all/contributing).
See the [Gazebo contributing guide](https://gazebosim.org/docs/all/contributing).
252 changes: 126 additions & 126 deletions Changelog.md

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions INSTALL_WINDOWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,9 @@ directory that has the source files. Here is an example:

To fix this problem, manually move the nested directories up one level.

1. Clone and prepare the Ignition Math dependency:
1. Clone and prepare the Gazebo Math dependency:

git clone https://github.com/ignitionrobotics/ign-math
git clone https://github.com/gazebosim/gz-math
cd ign-math
mkdir build

Expand All @@ -60,9 +60,9 @@ directory that has the source files. Here is an example:
..\configure
nmake install

1. Clone and prepare the Ignition Msgs dependency:
1. Clone and prepare the Gazebo Msgs dependency:

git clone https://github.com/ignitionrobotics/ign-msgs
git clone https://github.com/gazebosim/gz-msgs
cd ign-msgs
mkdir build

Expand All @@ -74,7 +74,7 @@ directory that has the source files. Here is an example:

1. Clone ign-transport:

git clone https://github.com/ignitionrobotics/ign-transport
git clone https://github.com/gazebosim/gz-transport
cd ign-transport
mkdir build

Expand Down
33 changes: 22 additions & 11 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,48 +6,59 @@ Deprecated code produces compile-time warnings. These warning serve as
notification to users that their code should be upgraded. The next major
release will remove the deprecated code.

## Ignition Transport 9.X to 10.X
## Gazebo Transport 11.X to 12.X

### Deprecated

1. The `ignition` namespace is deprecated and will be removed in future versions. Use `gz` instead.
chapulina marked this conversation as resolved.
Show resolved Hide resolved

1. Header files under `ignition/...` are deprecated and will be removed in future versions.
Use `gz/...` instead.

1. `IGN_TRANSPORT_LOG_SQL_PATH` is deprecated and will be removed in future versions.
Use `GZ_TRANSPORT_LOG_SQL_PATH` instead.

## Gazebo Transport 9.X to 10.X

### Addition

1. Dependency on `cli` component of `ignition-utils`.
* [GitHub pull request 229](https://github.com/ignitionrobotics/ign-transport/pull/229)
* [GitHub pull request 229](https://github.com/gazebosim/gz-transport/pull/229)

## Ignition Transport 8.X to 9.X
## Gazebo Transport 8.X to 9.X

### Removed

1. Remove deprecations before 9.x.x release
* [GitHub pull request 175](https://github.com/ignitionrobotics/ign-transport/pull/175)
* [GitHub pull request 175](https://github.com/gazebosim/gz-transport/pull/175)

## Ignition Transport 7.X to 8.X
## Gazebo Transport 7.X to 8.X

### Deprecated

1. NodeShared::TriggerSubscriberCallbacks
* [BitBucket pull request 404](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/404)

1. The discovery wire protocol changed to use ignition::msgs::Discovery
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
Transport 8+ will not work with Ignition Transport 7 and below.
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)

## Ignition Transport 6.X to 7.X
## Gazebo Transport 6.X to 7.X

### Removed

1. The `ign.hh` file is not longer installed.
* [BitBucket pull request 367](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/367)

## Ignition Transport 4.X to 5.X
## Gazebo Transport 4.X to 5.X

## Ignition Transport 3.X to 4.X
## Gazebo Transport 3.X to 4.X

1. Service responder callbacks passed to `Node::Advertise` should now return
a boolean value instead of taking in a boolean output parameter. The existing
functions have been deprecated.
* [BitBucket pull request 260](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/260)
* [BitBucket pull request 228](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-transport/pull-requests/228)

48 changes: 24 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# Ignition Transport
# Gazebo Transport

**Maintainer:** caguero AT openrobotics DOT org

[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-transport.svg)](https://github.com/ignitionrobotics/ign-transport/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-transport.svg)](https://github.com/ignitionrobotics/ign-transport/pulls)
[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-transport.svg)](https://github.com/gazebosim/gz-transport/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-transport.svg)](https://github.com/gazebosim/gz-transport/pulls)
[![Discourse topics](https://img.shields.io/discourse/https/community.gazebosim.org/topics.svg)](https://community.gazebosim.org)
[![Hex.pm](https://img.shields.io/hexpm/l/plug.svg)](https://www.apache.org/licenses/LICENSE-2.0)

Build | Status
-- | --
Test coverage | [![codecov](https://codecov.io/gh/ignitionrobotics/ign-transport/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-transport)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-transport/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-transport)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport-ci-main-focal-amd64)](https://build.osrfoundation.org/job/ignition_transport-ci-main-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_transport-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_transport-ci-main-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ign_transport-ci-win)](https://build.osrfoundation.org/job/ign_transport-ci-win/)

Ignition Transport, a component of [Ignition Robotics](https://ignitionrobotics.org), provides fast and efficient asyncronous message passing, services, and data logging.
Gazebo Transport, a component of [Gazebo](https://gazebosim.org), provides fast and efficient asyncronous message passing, services, and data logging.

# Table of Contents

Expand All @@ -40,27 +40,27 @@ Ignition Transport, a component of [Ignition Robotics](https://ignitionrobotics.

# Features

Ignition Transport is an open source communication library that allows
Gazebo Transport is an open source communication library that allows
exchanging data between clients. In our context, a client is called a node.
Nodes might be running within the same process in the same machine or in
machines located in different continents. Ignition Transport is multi-platform
machines located in different continents. Gazebo Transport is multi-platform
(Linux, Mac OS X, and Windows), so all the low level details, such as data
alignment or endianness are hidden for you.

Ignition Transport uses Google Protocol buffers as the data serialization format
Gazebo Transport uses Google Protocol buffers as the data serialization format
for communicating between nodes. Users can define their own messages using the
Protobuf utils, and then, exchange them between the nodes. Ignition Transport
Protobuf utils, and then, exchange them between the nodes. Gazebo Transport
discovers, serializes and delivers messages to the destinations using a
combination of custom code and ZeroMQ.

# Install

See the [installation tutorial](https://ignitionrobotics.org/api/transport/11.0/installation.html).
See the [installation tutorial](https://gazebosim.org/api/transport/11.0/installation.html).

# Usage

See [tutorials](https://ignitionrobotics.org/api/transport/11.0/tutorials.html)
and the [example directory](https://github.com/ignitionrobotics/ign-transport/blob/main/example/)
See [tutorials](https://gazebosim.org/api/transport/11.0/tutorials.html)
and the [example directory](https://github.com/gazebosim/gz-transport/blob/main/example/)
in the source code.

## Known issue of command line tools
Expand All @@ -69,52 +69,52 @@ 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 is to define the environment variable
`IGN_CONFIG_PATH` to point to the location of the Ignition library installation,
`GZ_CONFIG_PATH` to point to the location of the Ignition library installation,
where the YAML file for the package is found, such as
```
export IGN_CONFIG_PATH=/usr/local/share/ignition
export GZ_CONFIG_PATH=/usr/local/share/ignition
```

This issue is tracked [here](https://github.com/ignitionrobotics/ign-tools/issues/61).
This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/61).

# Documentation

Visit the [documentation page](https://ignitionrobotics.org/api/transport/11.0/index.html).
Visit the [documentation page](https://gazebosim.org/api/transport/11.0/index.html).

# Folder Structure

```
ign-transport
├── conf Configuration file for the integration with the `ign` CLI tool.
├── docker Dockerfile with ign-transport installed and scripts to build and run the code.
├── example Example programs that use most of the Ignition Transport API.
├── example Example programs that use most of the Gazebo Transport API.
├── include Header files that get installed.
├── log All the code related with Ignition Transport logging.
├── log All the code related with Gazebo Transport logging.
├── src Source code of the core library.
├── test A directory of integration, performance and regression tests.
└── tutorials A set of tutorials about Ignition Transport features.
└── tutorials A set of tutorials about Gazebo Transport features.
```

# Contributing

Please see
[CONTRIBUTING.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CONTRIBUTING.md).
[CONTRIBUTING.md](https://github.com/gazebosim/gz-sim/blob/main/CONTRIBUTING.md).

# Code of Conduct

Please see
[CODE_OF_CONDUCT.md](https://github.com/ignitionrobotics/ign-gazebo/blob/main/CODE_OF_CONDUCT.md).
[CODE_OF_CONDUCT.md](https://github.com/gazebosim/gz-sim/blob/main/CODE_OF_CONDUCT.md).

# Versioning

This library uses [Semantic Versioning](https://semver.org/). Additionally,
this library is part of the [Ignition Robotics project](https://ignitionrobotics.org)
this library is part of the [Gazebo project](https://gazebosim.org)
which periodically releases a versioned set of compatible and complimentary
libraries. See the [Ignition Robotics website](https://ignitionrobotics.org) for
libraries. See the [Gazebo website](https://gazebosim.org) for
version and release information.

# License

This library is licensed under [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0).
See also the [LICENSE](https://github.com/ignitionrobotics/ign-transport/raw/main/LICENSE)
See also the [LICENSE](https://github.com/gazebosim/gz-transport/raw/main/LICENSE)
file.
2 changes: 1 addition & 1 deletion api.md.in
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Ignition @IGN_DESIGNATION_CAP@

Ignition @IGN_DESIGNATION_CAP@ is a component in Ignition Robotics, a set of libraries
Ignition @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 docker/ign-transport/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ RUN sudo /bin/sh -c 'echo "deb [trusted=yes] http://packages.osrfoundation.org/g
&& sudo apt-get clean

# Ignition transport
RUN git clone https://github.com/ignitionrobotics/ign-transport.git \
RUN git clone https://github.com/gazebosim/gz-transport.git \
&& cd ign-transport \
&& mkdir build \
&& cd build \
Expand Down
2 changes: 1 addition & 1 deletion example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Examples

Example programs using Ignition Transport.
Example programs using Gazebo Transport.

## Build

Expand Down
Loading