Skip to content

Latest commit

 

History

History
129 lines (87 loc) · 5.3 KB

Migration.md

File metadata and controls

129 lines (87 loc) · 5.3 KB
Raw

Gazebo Fuel Tools 8.X to 9.X

Removals

  • GZ_FUEL_INITIAL_CONFIG_PATH macro removed from gz/fuel_tools/config.hh

Gazebo Fuel Tools 7.X to 8.X

Deprecations

  • Deprecation: ignition namespace
  • Replacement: gz namespace
  • Deprecation: ignition/... headers
  • Replacement: gz/... headers
  • The following ign_ prefixed macros are deprecated and will be removed in future versions. Additionally, they will only be available when including the corresponding ignition/... header. Use the gz_ prefix instead.
    • ign_strcat, ign_strcpy, ign_sprintf, ign_strdup
  • The default cache location has moved from ~/.ignition/fuel to ~/.gz/fuel.

Breaking Changes

  • 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 Fuel Tools 5.X to 6.X

Deprecations

  • Deprecation: FuelClient::DeleteModel
  • Replacement: FuelClient::DeleteUrl
  • Deprecation: FuelClient constructor that takes LocalCache
  • Replacement: FuelClient constructor without LocalCache

Gazebo Fuel Tools 4.X to 5.X

Deprecations

  • Deprecation: LocalCache
  • Replacement: None

Gazebo Fuel Tools 3.X to 4.X

Depercations

  1. The fuel.ignitionrobotics.org Fuel server has been deprecated, and redirects to fuel.gazebosim.org. Use fuel.gazebosim.org in all Fuel URLs.

Modifications

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

Gazebo Fuel Tools 1.X to 2.X

Modifications

  1. Renamed the REST class to Rest.

  2. All setters (functions that set class variables) have been prefixed with Set and existing functions deprecated. Acronyms within class and function names have been changed from all-caps (e.g URL) to camel-case (eg. Url).

  3. Deprecated env function. Please use igition::common::env.

  4. Deprecated the ModelIdentifier::Category functions. The Category concept does not exist on fuelserver.

  5. Deprecated the accessor ModelIdentifier::Likes for ModelIdentifier::LikeCount, and the mutator ModelIdentifier::Likes for ModelIdentifier::SetLikeCount.

  6. Deprecated the accessor ModelIdentifier::Downloads for ModelIdentifier::DownloadCount, and the mutator ModelIdentifier::Downloads for ModelIdentifier::SetDownloadCount.

  7. ResultTypes have moved from a plain enum inside the Result class to an enum class ResultType outside the Result class scope.

  8. ResultType Result::Type() const now returns an enum class instead of a plain enum. This should not affect you unless you have been mapping ResultType to an int.

Gazebo Fuel Tools 1.2 to 1.X

Modifications

Gazebo Fuel Tools 1.0 to 1.2

Modifications

  1. Model unique name doesn't contain server API version anymore, for example:

  2. Servers no longer have a local name: API calls return garbage and config fields are ignored.

  3. Cache structure has been changed, for example:

    • Old

      /home/user/.ignition/fuel/ └── models └── username └── modelname

    • New

      /home/user/.ignition/fuel/ └── serverurl.org └── username └── models └── modelname ├── 1 └── 2