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-utils #61

Merged
merged 22 commits into from
May 28, 2022
Merged
Show file tree
Hide file tree
Changes from 21 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
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [https://ignitionrobotics.org/support](https://ignitionrobotics.org/support). All
reported by contacting the project team at [https://gazebosim.org/support](https://gazebosim.org/support). All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
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).
66 changes: 33 additions & 33 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,77 +1,77 @@
## Ignition Utils 2.x
## Gazebo Utils 2.x

## Ignition Utils 2.0.0 (20XX-XX-XX)
## Gazebo Utils 2.0.0 (20XX-XX-XX)

## Ignition Utils 1.x
## Gazebo Utils 1.x

## Ignition Utils 1.4.0 (2022-03-29)
## Gazebo Utils 1.4.0 (2022-03-29)

1. Enable cpplint
* [Pull request #41](https://github.com/ignitionrobotics/ign-utils/pull/41)
* [Pull request #41](https://github.com/gazebosim/gz-utils/pull/41)

1. Add doxygen linters
* [Pull request #44](https://github.com/ignitionrobotics/ign-utils/pull/44)
* [Pull request #44](https://github.com/gazebosim/gz-utils/pull/44)

1. Custom Ignition CLI11 formatter
* [Pull request #42](https://github.com/ignitionrobotics/ign-utils/pull/42)
1. Custom Gazebo CLI11 formatter
* [Pull request #42](https://github.com/gazebosim/gz-utils/pull/42)

1. Drop all main functions from gtest files
* [Pull request #45](https://github.com/ignitionrobotics/ign-utils/pull/45)
* [Pull request #45](https://github.com/gazebosim/gz-utils/pull/45)

1. Improvements to enable "-Wconversion"
* [Pull request #46](https://github.com/ignitionrobotics/ign-utils/pull/46)
* [Pull request #46](https://github.com/gazebosim/gz-utils/pull/46)

## Ignition Utils 1.3.0 (2022-02-24)
## Gazebo Utils 1.3.0 (2022-02-24)

1. Fix inline namespace issue with clang6
* [Pull request #39](https://github.com/ignitionrobotics/ign-utils/pull/39)
* [Pull request #39](https://github.com/gazebosim/gz-utils/pull/39)

1. Move ExtraTestMacros from ign-cmake
* [Pull request #37](https://github.com/ignitionrobotics/ign-utils/pull/37)
* [Pull request #37](https://github.com/gazebosim/gz-utils/pull/37)

## Ignition Utils 1.2.0 (2022-01-28)
## Gazebo Utils 1.2.0 (2022-01-28)

1. Enable cpplint on focal
* [Pull request #32](https://github.com/ignitionrobotics/ign-utils/pull/32)
* [Pull request #32](https://github.com/gazebosim/gz-utils/pull/32)

1. Add NeverDestroyed utility class
* [Pull request #31](https://github.com/ignitionrobotics/ign-utils/pull/31)
* [Pull request #31](https://github.com/gazebosim/gz-utils/pull/31)

1. Move environment functionality to utils
* [Pull request #30](https://github.com/ignitionrobotics/ign-utils/pull/30)
* [Pull request #30](https://github.com/gazebosim/gz-utils/pull/30)

1. ImplPtr Get method
* [Pull request #27](https://github.com/ignitionrobotics/ign-utils/pull/27)
* [Pull request #27](https://github.com/gazebosim/gz-utils/pull/27)

## Ignition Utils 1.1.0 (2021-09-02)
## Gazebo Utils 1.1.0 (2021-09-02)

1. More complete bazel implementation
* [Pull request #21](https://github.com/ignitionrobotics/ign-utils/pull/21)
* [Pull request #21](https://github.com/gazebosim/gz-utils/pull/21)

1. Add IGN_UTILS_VENDOR_CLI11 CMake option to optionally use external CLI11
* [Pull request #19](https://github.com/ignitionrobotics/ign-utils/pull/19)
* [Pull request #19](https://github.com/gazebosim/gz-utils/pull/19)

1. Add an example program using CLI11
* [Pull request #23](https://github.com/ignitionrobotics/ign-utils/pull/23)
* [Pull request #23](https://github.com/gazebosim/gz-utils/pull/23)

## Ignition Utils 1.0.0 (2021-03-30)
## Gazebo Utils 1.0.0 (2021-03-30)

1. Add basic support for bazel build system.
* [Pull request #14](https://github.com/ignitionrobotics/ign-utils/pull/14)
* [Pull request #14](https://github.com/gazebosim/gz-utils/pull/14)

1. Ignition ImplPtr
* [Pull request 1](https://github.com/ignitionrobotics/ign-utils/pull/1)
* [Pull request 4](https://github.com/ignitionrobotics/ign-utils/pull/4)
1. Gazebo ImplPtr
* [Pull request 1](https://github.com/gazebosim/gz-utils/pull/1)
* [Pull request 4](https://github.com/gazebosim/gz-utils/pull/4)

1. Vendor CLI11 library inside ignition-utils
* [Pull request 2](https://github.com/ignitionrobotics/ign-utils/pull/2)
* [Pull request 2](https://github.com/gazebosim/gz-utils/pull/2)

1. Update warning suppression macros
* [Pull request 5](https://github.com/ignitionrobotics/ign-utils/pull/5)
* [Pull request 10](https://github.com/ignitionrobotics/ign-utils/pull/10)
* [Pull request 11](https://github.com/ignitionrobotics/ign-utils/pull/11)
* [Pull request 5](https://github.com/gazebosim/gz-utils/pull/5)
* [Pull request 10](https://github.com/gazebosim/gz-utils/pull/10)
* [Pull request 11](https://github.com/gazebosim/gz-utils/pull/11)

1. Pre-release cleanup
* [Pull request #16](https://github.com/ignitionrobotics/ign-utils/pull/16)
* [Pull request #15](https://github.com/ignitionrobotics/ign-utils/pull/15)
* [Pull request #16](https://github.com/gazebosim/gz-utils/pull/16)
* [Pull request #15](https://github.com/gazebosim/gz-utils/pull/15)

12 changes: 10 additions & 2 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,20 @@ 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 Utils 1.2 to 1.3
## Gazebo Utils 1.X to 2.X

* The `ignition` namespace is deprecated and will be removed in future versions.
Use `gz` instead.

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

## Gazebo Utils 1.2 to 1.3

Recommended migration:
Utils 1.3.0 introduces the `ExtraTestMacros.hh` headers that are also in ign-cmake.
This is an effort to remove all headers from ign-cmake and locate them in ign-utils.
To update, replace all instances of `ignition/utilities/ExtraTestMacros.hh` with `ignition/utils/ExtraTestMacros.hh`
In the future, `ignition/utilities/ExtraTestMacros.hh` will be removed from ign-cmake.

## Ignition Utils 0.X to 1.X
## Gazebo Utils 0.X to 1.X
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
# Ignition Utils : Classes and functions for robot applications
# Gazebo Utils : Classes and functions for robot applications

**Maintainer:** addisu AT openrobotics DOT org

[![GitHub open issues](https://img.shields.io/github/issues-raw/ignitionrobotics/ign-utils.svg)](https://github.com/ignitionrobotics/ign-utils/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/ignitionrobotics/ign-utils.svg)](https://github.com/ignitionrobotics/ign-utils/pulls)
[![GitHub open issues](https://img.shields.io/github/issues-raw/gazebosim/gz-utils.svg)](https://github.com/gazebosim/gz-utils/issues)
[![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/gazebosim/gz-utils.svg)](https://github.com/gazebosim/gz-utils/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-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/ignitionrobotics/ign-utils)
Test coverage | [![codecov](https://codecov.io/gh/gazebosim/gz-utils/branch/main/graph/badge.svg)](https://codecov.io/gh/gazebosim/gz-utils)
Ubuntu Focal | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_utils-ci-main-focal-amd64)](https://build.osrfoundation.org/job/ignition_utils-ci-main-focal-amd64)
Homebrew | [![Build Status](https://build.osrfoundation.org/buildStatus/icon?job=ignition_utils-ci-main-homebrew-amd64)](https://build.osrfoundation.org/job/ignition_utils-ci-main-homebrew-amd64)
Windows | [![Build Status](https://build.osrfoundation.org/job/ign_utils-ci-win/badge/icon)](https://build.osrfoundation.org/job/ign_utils-ci-win/)

Ignition Utils, a component of [Ignition
Robotics](https://ignitionrobotics.org), provides general purpose
Gazebo Utils, a component of [Ignition
Robotics](https://gazebosim.org), provides general purpose
classes and functions designed for robotic applications.

# Table of Contents
Expand All @@ -42,23 +42,23 @@ classes and functions designed for robotic applications.

# Features

Ignition Utils provides a wide range of functionality, including:
Gazebo Utils provides a wide range of functionality, including:

* A helper class to implement the PIMPL pattern
* A command line parsing utility (vendored [CLI11](https://github.com/CLIUtils/CLI11/))
* Macros to suppress warnings

# Install

See the [installation tutorial](https://ignitionrobotics.org/api/utils/0.1/install.html).
See the [installation tutorial](https://gazebosim.org/api/utils/0.1/install.html).

# Usage

Please refer to the [examples directory](https://github.com/ignitionrobotics/ign-utils/blob/main/examples/).
Please refer to the [examples directory](https://github.com/gazebosim/gz-utils/blob/main/examples/).

# Documentation

API and tutorials can be found at [https://ignitionrobotics.org/libs/utils](https://ignitionrobotics.org/libs/utils).
API and tutorials can be found at [https://gazebosim.org/libs/utils](https://gazebosim.org/libs/utils).

You can also generate the documentation from a clone of this repository by following these steps.

Expand All @@ -71,7 +71,7 @@ You can also generate the documentation from a clone of this repository by follo
2. Clone the repository

```
git clone https://github.com/ignitionrobotics/ign-utils
git clone https://github.com/gazebosim/gz-utils
```

3. Configure and build the documentation.
Expand All @@ -90,7 +90,7 @@ You can also generate the documentation from a clone of this repository by follo

Follow these steps to run tests and static code analysis in your clone of this repository.

1. Follow the [source install instruction](https://ignitionrobotics.org/libs/utils#source-install).
1. Follow the [source install instruction](https://gazebosim.org/libs/utils#source-install).

2. Run tests.

Expand Down Expand Up @@ -124,27 +124,27 @@ ign-utils
# Contributing

Please see
[CONTRIBUTING.md](https://ignitionrobotics.org/docs/all/contributing).
[CONTRIBUTING.md](https://gazebosim.org/docs/all/contributing).

# Code of Conduct

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

# Versioning

This library uses [Semantic Versioning](https://semver.org/).
Additionally, this library is part of the
[Ignition project](https://ignitionrobotics.org) which periodically
[Ignition project](https://gazebosim.org) which periodically
releases a versioned set of compatible and complimentary libraries. See the
[Ignition website](https://ignitionrobotics.org) for version and
[Ignition 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-utils/blob/main/LICENSE)
[LICENSE](https://github.com/gazebosim/gz-utils/blob/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
Ignition @IGN_DESIGNATION_CAP@ is a component in Gazebo, a set of
libraries designed to rapidly develop robot and simulation applications.
This library defines a general set of utilities with an eye toward simulation
and robotics.
Expand Down
2 changes: 1 addition & 1 deletion cli/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Ignition CLI component
Gazebo CLI component

Vendored from https://github.com/CLIUtils/CLI11/

Expand Down
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/App.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/App.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/CLI.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/CLI.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Config.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Config.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/ConfigFwd.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Error.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Error.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Formatter.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/FormatterFwd.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Macros.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Macros.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Option.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Option.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Split.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Split.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/StringTools.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Timer.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Timer.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/TypeTools.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Validators.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/external-cli/ignition/utils/cli/Version.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Version.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/ignition/utils/cli.hh
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli.hh>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/ignition/utils/cli/IgnitionFormatter.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/GzFormatter.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/vendored-cli/ignition/utils/cli/App.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/App.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/vendored-cli/ignition/utils/cli/CLI.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/CLI.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/vendored-cli/ignition/utils/cli/Config.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Config.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/ConfigFwd.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/vendored-cli/ignition/utils/cli/Error.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Error.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Formatter.hpp>
#include <ignition/utils/config.hh>
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/FormatterFwd.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/vendored-cli/ignition/utils/cli/Macros.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Macros.hpp>
#include <ignition/utils/config.hh>
1 change: 1 addition & 0 deletions cli/include/vendored-cli/ignition/utils/cli/Option.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@
*/

#include <gz/utils/cli/Option.hpp>
#include <ignition/utils/config.hh>
Loading