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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jun 28, 2022
+23 −19
Merged

ign -> gz Partial Docs Migration and Project Name Followups : gz-utils #67

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77b64dd
Migrate some docs and project names in macros
methylDragon Jun 27, 2022
7905bd6
Add project name migration note in Migration.md
methylDragon Jun 27, 2022
1a1e7e3
Fix Gazebo Robotics
methylDragon Jun 28, 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 CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ cmake_minimum_required(VERSION 3.10.2 FATAL_ERROR)
project(gz-utils2 VERSION 2.0.0)

#============================================================================
# Find ignition-cmake
# Find gz-cmake
#============================================================================
# If you get an error at this line, you need to install ignition-cmake
find_package(gz-cmake3 REQUIRED)
Expand Down
2 changes: 1 addition & 1 deletion Changelog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
1. Fix inline namespace issue with clang6
* [Pull request #39](https://github.com/gazebosim/gz-utils/pull/39)

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

## Gazebo Utils 1.2.0 (2022-01-28)
Expand Down
14 changes: 10 additions & 4 deletions Migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,23 @@ release will remove the deprecated code.
* `IGN_UTILS_UNIQUE_IMPL_PTR_FWD`
* `IGN_UTILS_IMPL_PTR`
* `IGN_UTILS_UNIQUE_IMPL_PTR`
* `IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR`, `IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR`
* `IGN_UTILS_WARN_IGNORE__NON_VIRTUAL_DESTRUCTOR`, `IGN_UTILS_WARN_RESUME__NON_VIRTUAL_DESTRUCTOR`
* `IGN_UTILS_WARN_IGNORE__DLL_INTERFACE_MISSING`, `IGN_UTILS_WARN_RESUME__DLL_INTERFACE_MISSING`
* `IGN_UTILS_WARN_IGNORE__DEPRECATED_DECLARATION`, `IGN_UTILS_WARN_RESUME__DEPRECATED_DECLARATION`

* 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 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.
Utils 1.3.0 introduces the `ExtraTestMacros.hh` headers that are also in gz-cmake.
This is an effort to remove all headers from gz-cmake and locate them in gz-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.
In the future, `ignition/utilities/ExtraTestMacros.hh` will be removed from gz-cmake.

## Gazebo Utils 0.X to 1.X
12 changes: 5 additions & 7 deletions README.md
View file
Open in desktop
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_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/)

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

# Table of Contents
Expand Down Expand Up @@ -77,7 +76,7 @@ You can also generate the documentation from a clone of this repository by follo
3. Configure and build the documentation.

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

4. View the documentation by running the following command from the build directory.
Expand Down Expand Up @@ -109,7 +108,7 @@ Follow these steps to run tests and static code analysis in your clone of this r
Refer to the following table for information about important directories and files in this repository.

```
ign-utils
gz-utils
├── examples Example programs.
├── include/ignition/utils Header files.
├── src Source files and unit tests.
Expand All @@ -135,9 +134,9 @@ Please see

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

# License
Expand All @@ -147,4 +146,3 @@ This library is licensed under
See also the
[LICENSE](https://github.com/gazebosim/gz-utils/blob/main/LICENSE)
file.

4 changes: 2 additions & 2 deletions api.md.in
View file
Open in desktop
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
Gazebo @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
4 changes: 2 additions & 2 deletions tutorials.md.in
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**
Expand Down
4 changes: 2 additions & 2 deletions tutorials/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ necessary prerequisites followed by building from source.
2. Clone the repository

```
git clone https://github.com/gazebosim/gz-utils -b ign-utils<#>
git clone https://github.com/gazebosim/gz-utils -b gz-utils<#>
```
Be sure to replace `<#>` with a number value, such as 1 or 2, depending on
which version you need.
Expand All @@ -76,7 +76,7 @@ necessary prerequisites followed by building from source.
4. Configure and build

```
cd ign-utils; mkdir build; cd build; cmake ..; make
cd gz-utils; mkdir build; cd build; cmake ..; make
```

5. Optionally, install Gazebo Utils
Expand Down