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-fuel-tools #251

Merged
merged 25 commits into from
May 29, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
c357c82
Update header guards
methylDragon May 18, 2022
fdff44d
Migrate namespaces
methylDragon May 18, 2022
2bbde9b
Add migration line
methylDragon May 18, 2022
24153be
Implement deprecation trick
methylDragon May 18, 2022
f1617d4
Add deprecation test
methylDragon May 18, 2022
32ea67c
Include config.hh
methylDragon May 18, 2022
09863fa
Use pragma deprecation message instead
methylDragon May 19, 2022
7ba6c40
Ticktock config macros
methylDragon May 19, 2022
2b9e799
Migrate includes to gz
methylDragon May 20, 2022
5e294ac
Mention gz headers in migration
methylDragon May 20, 2022
bdd6706
Update config.hh
methylDragon May 20, 2022
39dd741
Migrate Export.hh macros and deprecated test
methylDragon May 20, 2022
7886d7b
Migrate more macros and test_config.h
methylDragon May 20, 2022
4ffd59e
Migrate github links
methylDragon May 20, 2022
aff111e
Migrate user-facing Ignition to Gazebo
methylDragon May 20, 2022
b35d6d3
Migrate gz-common logging calls
methylDragon May 20, 2022
3a55ad2
Include config.hh in recursive directories and <lib>.hh
methylDragon May 22, 2022
83df185
`Gazebo Robotics` -> `Gazebo`
methylDragon May 23, 2022
5e6ba10
`ignitionrobotics` -> `gazebosim`
methylDragon May 23, 2022
f165602
Revert migration for fuel.ignitionrobotics.org
methylDragon May 23, 2022
acc1d37
Rollback osrf-migration.github.io migrations
methylDragon May 24, 2022
c540e70
Revert URL changes in code
methylDragon May 25, 2022
f3d46db
Wording changes
methylDragon May 25, 2022
989bbe0
Migrate `igndbg` -> `gzdbg`
methylDragon May 25, 2022
214227d
Post-rebase `gzerr`, `gzdbg`, `Gazebo Fuel Tools` migration
methylDragon May 25, 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 .github/ci/after_make.sh
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ set -x
make install

# So ign-tools finds fuel-tools
export IGN_CONFIG_PATH=/usr/local/share/ignition
export GZ_CONFIG_PATH=/usr/local/share/ignition
export LD_LIBRARY_PATH=/usr/local/lib/:$LD_LIBRARY_PATH

# Compile example
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).
198 changes: 99 additions & 99 deletions Changelog.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions INSTALL_WINDOWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ need to [disable the Windows firewall](http://windows.microsoft.com/en-us/window

"C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\vcvarsall.bat" amd64

1. Clone Ignition Fuel-Tools:
1. Clone Gazebo Fuel-Tools:

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

Expand All @@ -38,7 +38,7 @@ need to [disable the Windows firewall](http://windows.microsoft.com/en-us/window
nmake install


You should now have an installation of Ignition Fuel-Tools in ign-ws/ign-fuel-tools/build/install.
You should now have an installation of Gazebo Fuel-Tools in ign-ws/ign-fuel-tools/build/install.

## Run tests

Expand Down
26 changes: 17 additions & 9 deletions Migration.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,36 @@
## Ignition Fuel Tools 5.X to 6.X
## Gazebo Fuel Tools 7.X to 8.X

### Deprecations

* **Deprecation**: `FuelClient::DeleteModel`
* **Replacement**: `FielClient::DeleteUrl`
* **Deprecation**: `ignition` namespace
* **Replacement**: `gz` namespace
* **Deprecation**: `ignition/...` headers
* **Replacement**: `gz/...` headers

## Gazebo Fuel Tools 5.X to 6.X

### Deprecations

* **Deprecation**: `FuelClient::DeleteModel`
* **Replacement**: `FuelClient::DeleteUrl`
* **Deprecation**: `FuelClient` constructor that takes `LocalCache`
* **Replacement**: `FielClient` constructor without `LocalCache`
* **Replacement**: `FuelClient` constructor without `LocalCache`

## Ignition Fuel Tools 4.X to 5.X
## Gazebo Fuel Tools 4.X to 5.X

### Deprecations

* **Deprecation**: `LocalCache`
* **Replacement**: None

## Ignition Fuel Tools 3.X to 4.X
## Gazebo Fuel Tools 3.X to 4.X

### Modifications

1. `FuelClient::UploadModel` takes 2 more arguments now.
1. `RestClient::Request`'s `_form` argument is now an `std::multimap` instead of `std::map`.

## Ignition Fuel Tools 1.X to 2.X
## Gazebo Fuel Tools 1.X to 2.X

### Modifications

Expand Down Expand Up @@ -59,13 +67,13 @@
been mapping `ResultType` to an `int`.
* [BitBucket pull request #51](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-fuel-tools/pull-requests/51/update-result-style/diff#chg-include/ignition/fuel_tools/Result.hh)

## Ignition Fuel Tools 1.2 to 1.X
## Gazebo Fuel Tools 1.2 to 1.X

### Modifications



## Ignition Fuel Tools 1.0 to 1.2
## Gazebo Fuel Tools 1.0 to 1.2

### Modifications

Expand Down
2 changes: 1 addition & 1 deletion NEWS
Original file line number Diff line number Diff line change
@@ -1 +1 @@
http://bitbucket.org/ignitionrobotics/ign-rndf
http://bitbucket.org/gazebosim/gz-rndf
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Ignition Fuel Tools: Classes and tools for interacting with Ignition Fuel
# Gazebo Fuel Tools: Classes and tools for interacting with Gazebo Fuel

**Maintainer:** nate AT openrobotics DOT org

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

Ignition Fuel Tools is composed by a client library and command line tools for
interacting with Ignition Fuel servers.
Gazebo Fuel Tools is composed by a client library and command line tools for
interacting with Gazebo Fuel servers.

[http://github.com/ignitionrobotics/ign-fuel-tools](http://github.com/ignitionrobotics/ign-fuel-tools)
[http://github.com/gazebosim/gz-fuel-tools](http://github.com/gazebosim/gz-fuel-tools)

# Building and installing

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

Make sure `IGN_CONFIG_PATH` is set to the right install location so that `ign fuel` will work.
Make sure `GZ_CONFIG_PATH` is set to the right install location so that `ign fuel` will work.
Default is `/usr/local/share/ignition`.

## Examples
Expand Down Expand Up @@ -61,9 +61,9 @@ Download succeeded.
**C++ Get List models**
```
// Create a client (uses https://fuel.ignitionrobotics.org by default)
ignition::fuel_tools::ClientConfig conf;
ignition::fuel_tools::FuelClient client(conf);
ignition::fuel_tools::ModelIter iter = client.Models();
gz::fuel_tools::ClientConfig conf;
gz::fuel_tools::FuelClient client(conf);
gz::fuel_tools::ModelIter iter = client.Models();
while (iter)
{
std::cout << "Got model: " << iter->Identification().Name() << "\n";
Expand All @@ -73,7 +73,7 @@ Download succeeded.
**Upload a model**

Create an account on
[https://app.ignitionrobotics.org/](https://app.ignitionrobotics.org/) and log
[https://app.gazebosim.org/](https://app.gazebosim.org/) and log
in.

While logged in, obtain the JWT token of the account from the browser.
Expand Down Expand Up @@ -169,10 +169,10 @@ 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 for a single package 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
```

However, that environment variable only takes a single path, which means if the
Expand All @@ -187,7 +187,7 @@ ln -s /usr/local/share/ignition/fuel4.yaml .
ln -s /usr/local/share/ignition/transport7.yaml .
ln -s /usr/local/share/ignition/transportlog7.yaml .
...
export IGN_CONFIG_PATH=$HOME/.ignition/tools/configs
export GZ_CONFIG_PATH=$HOME/.ignition/tools/configs
```

This issue is tracked [here](https://github.com/ignitionrobotics/ign-tools/issues/8).
This issue is tracked [here](https://github.com/gazebosim/gz-tools/issues/8).
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
12 changes: 6 additions & 6 deletions doc/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,22 @@
<meta name="keywords" content="$projectname">
<title>$projectname: $title</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="https://ignitionrobotics.org/assets/doxygen/dynsections.js"></script>
<script type="text/javascript" src="https://gazebosim.org/assets/doxygen/dynsections.js"></script>

<link href='http://fonts.googleapis.com/css?family=Roboto:400,300,100,500,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.deep_orange-blue.min.css">
<script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>

<link href="https://ignitionrobotics.org/assets/doxygen/doxygen.css" rel="stylesheet" type="text/css">
<link href="https://gazebosim.org/assets/doxygen/doxygen.css" rel="stylesheet" type="text/css">
</head>

<body>

<div class="mdl-layout mdl-js-layout mdl-layout--fixed-drawer">
<div class="mdl-layout__drawer mdl-color--grey-100 mdl-color-text--blue-grey-50">
<header class="mdl-color--grey-100">
<a href="index.html"><img width="60px" src="https://ignitionrobotics.org/assets/doxygen/ignition_logo.svg"/></a>
<a href="index.html"><img width="60px" src="https://gazebosim.org/assets/doxygen/ignition_logo.svg"/></a>
<h1 class="project_title">$projectname</h1>
<h2>API Reference</h2>
<div class="version">
Expand All @@ -46,11 +46,11 @@ <h2>API Reference</h2>
<i class="mdl-color-text--grey-400 material-icons"
role="presentation">insert_drive_file</i>Files</a>
<a class="mdl-navigation__link" target="_blank"
href="http://ignitionrobotics.org">
href="http://gazebosim.org">
<i class="mdl-color-text--grey-400 material-icons"
role="presentation">launch</i>Ignition Website</a>
role="presentation">launch</i>Gazebo Website</a>
<a class="mdl-navigation__link" target="_blank"
href="https://github.com/ignitionrobotics/ign-fuel-tools/issues/new">
href="https://github.com/gazebosim/gz-fuel-tools/issues/new">
<i class="mdl-color-text--grey-400 material-icons"
role="presentation">warning</i>Report Issues</a>

Expand Down
6 changes: 3 additions & 3 deletions doc/ignition.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Ignition Fuel Tools"
PROJECT_NAME = "Gazebo Fuel Tools"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -900,7 +900,7 @@ IMAGE_PATH =
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.

INPUT_FILTER = "sed -e 's/ignition::fuel_tools:://g'"
INPUT_FILTER = "sed -e 's/gz::fuel_tools:://g'"

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
Expand Down Expand Up @@ -1229,7 +1229,7 @@ GENERATE_DOCSET = NO
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_FEEDNAME = "Ignition FUEL TOOLS API Documentation"
DOCSET_FEEDNAME = "Gazebo FUEL TOOLS API Documentation"

# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
Expand Down
6 changes: 3 additions & 3 deletions doc/tutorials-header.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@
<meta name="keywords" content="$projectname">
<title>$projectname: $title</title>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="https://ignitionrobotics.org/assets/doxygen/dynsections.js"></script>
<script type="text/javascript" src="https://gazebosim.org/assets/doxygen/dynsections.js"></script>

<link href='http://fonts.googleapis.com/css?family=Roboto:400,300,100,500,700' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.deep_orange-blue.min.css">
<script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>

<link href="https://ignitionrobotics.org/assets/doxygen/tutorials-doxygen.css" rel="stylesheet" type="text/css">
<link href="https://gazebosim.org/assets/doxygen/tutorials-doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
Expand All @@ -23,7 +23,7 @@
<div class="mdl-layout mdl-layout--fixed-header mdl-js-layout mdl-color--grey-100">
<header class="mdl-layout__header mdl-layout__header--scroll mdl-color--blue-grey-700 mdl-color-text--grey-100">
<div class="mdl-layout__header-row">
<a href="index.html"><img width="40px" src="https://ignitionrobotics.org/assets/doxygen/ignition_logo_white.svg"/></a>
<a href="index.html"><img width="40px" src="https://gazebosim.org/assets/doxygen/ignition_logo_white.svg"/></a>
<span class="mdl-layout-title">$projectname Tutorials</span>
</div>
</header>
Expand Down
6 changes: 3 additions & 3 deletions doc/tutorials.in
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places.
# The default value is: My Project.

PROJECT_NAME = "Ignition Fuel Tools"
PROJECT_NAME = "Gazebo Fuel Tools"

# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
Expand Down Expand Up @@ -898,7 +898,7 @@ IMAGE_PATH =
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# properly processed by doxygen.

INPUT_FILTER = "sed -e 's/ignition::fuel_tools:://g'"
INPUT_FILTER = "sed -e 's/gz::fuel_tools:://g'"

# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern
# basis. Doxygen will compare the file name with each pattern and apply the
Expand Down Expand Up @@ -1227,7 +1227,7 @@ GENERATE_DOCSET = NO
# The default value is: Doxygen generated docs.
# This tag requires that the tag GENERATE_DOCSET is set to YES.

DOCSET_FEEDNAME = "Ignition Fuel Tools API Documentation"
DOCSET_FEEDNAME = "Gazebo Fuel Tools API Documentation"

# This tag specifies a string that should uniquely identify the documentation
# set bundle. This should be a reverse domain-name style string, e.g.
Expand Down
2 changes: 1 addition & 1 deletion example/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 2.8 FATAL_ERROR)

# Find the Ignition Fuel Tools library
# Find the Gazebo Fuel Tools library
find_package(ignition-fuel_tools8 QUIET REQUIRED)
set (CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} ${IGNITION-FUEL-TOOLS_CXX_FLAGS}")
include_directories(
Expand Down
6 changes: 3 additions & 3 deletions example/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Examples

These examples demonstrate various Ignition Fuel tools features.
These examples demonstrate various Gazebo Fuel tools features.

### Dependencies

Expand All @@ -19,10 +19,10 @@ conda install gflags --channel conda-forge

## Build

After installing Ignition Fuel tools, from source or from binaries, build with:
After installing Gazebo Fuel tools, from source or from binaries, build with:

```
git clone https://github.com/ignitionrobotics/ign-fuel-tools/
git clone https://github.com/gazebosim/gz-fuel-tools/
cd ign-fuel-tools/example
mkdir build
cd build
Expand Down
2 changes: 1 addition & 1 deletion example/configure.bat
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
@set IGN_FUEL-TOOLS_PATH=%cd%\..\..\build\install\%build_type%

cmake -G "NMake Makefiles"^
-DCMAKE_PREFIX_PATH="%IGN_PATH_PATH%\lib\cmake\ignition-fuel-tools0;"^
-DCMAKE_PREFIX_PATH="%GZ_PATH%\lib\cmake\ignition-fuel-tools0;"^
-DCMAKE_INSTALL_PREFIX="install"^
-DCMAKE_BUILD_TYPE=%build_type%^
..
Expand Down
Loading