ros / geometry

Packages for common geometric calculations including the ROS transform library, "tf". Also includes ROS bindings for "bullet" physics engine and "kdl" kinematics/dynamics package.
173 stars 275 forks source link

Deprecation warnings #172

Open chapulina opened 6 years ago

chapulina commented 6 years ago

According to the wiki page:

Migration: Since ROS Hydro, tf has been "deprecated" in favor of tf2. tf2 is an iteration on tf providing generally the same feature set more efficiently. ... tf will continue to be supported for through at least J Turtle.

How about adding deprecation warnings to all the code in this repo?

I'd also suggest adding a README file with a warning and a link to the new recommended packages.

tfoote commented 6 years ago

That warning on the wiki page comes from the package.xml in the root of the package: https://github.com/ros/geometry/blob/f91b5efc160c40b6d45081fa4a5afc6b829e2059/tf/package.xml#L12

We've been doing a soft deprecation since now it's only an API wrapper on the new implementation. Maintaining the wrapper isn't too much work and there's still a lot of code using it. Now that we're past J turtle we could start more actively deprecating it. Targeting N-Turtle for deprecation with lots of compiler warnings and removal in O turtle might make sense.

mortenfyhn commented 5 years ago

How about modifying the repo description or adding a readme file that clearly states that the geometry2 repo should be preferred? It's easy to arrive here from a web search, find a header file with some useful stuff, and start using for instance this repo's eigen_conversions instead of geometry2's tf2_eigen, and so on.