Skip to content

Commit

Permalink
Migrate some docs and project names in macros
Browse files Browse the repository at this point in the history
Signed-off-by: methylDragon <[email protected]>
  • Loading branch information
methylDragon committed Jun 28, 2022
1 parent 99acf96 commit e50fbe4
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
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
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
6 changes: 3 additions & 3 deletions Migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ release will remove the deprecated code.
## 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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +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
Gazebo Utils, a component of [Gazebo
Robotics](https://gazebosim.org), provides general purpose
classes and functions designed for robotic applications.

Expand Down Expand Up @@ -77,7 +77,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 +109,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 +135,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 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
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
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
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

0 comments on commit e50fbe4

Please sign in to comment.