From 0daa109ccc27d9fb1a32b6c8a979abb2f0014346 Mon Sep 17 00:00:00 2001 From: Chris Lalancette Date: Fri, 17 Sep 2021 08:48:30 -0400 Subject: [PATCH] Add a release note for TF2 enumerator deprecation. (#1957) Signed-off-by: Chris Lalancette (cherry picked from commit 871af9c9714c5a2dffefd8d2443c4691b6db1d10) --- source/Releases/Release-Humble-Hawksbill.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/source/Releases/Release-Humble-Hawksbill.rst b/source/Releases/Release-Humble-Hawksbill.rst index 2ae8ff99c5..43156982dc 100644 --- a/source/Releases/Release-Humble-Hawksbill.rst +++ b/source/Releases/Release-Humble-Hawksbill.rst @@ -263,6 +263,19 @@ The CMake function ``rosidl_target_interfaces()`` has been deprecated, and now i Users wanting to use messages/services/actions in the same ROS package that generated them should instead call ``rosidl_get_typesupport_target()`` and then ``target_link_libraries()`` to make their targets depend on the returned typesupport target. See https://github.com/ros2/rosidl/pull/606 for more details, and https://github.com/ros2/demos/pull/529 for an example of using the new function. +geometry2 +^^^^^^^^^ + +Deprecation of TF2Error::NO_ERROR, etc +"""""""""""""""""""""""""""""""""""""" + +The ``tf2`` library uses an enumeration called ``TF2Error`` to return errors. +Unfortunately, one of the enumerators in there is called ``NO_ERROR``, which conflicts with a macro on Windows. +To remedy this, a new set of enumerators in ``TF2Error`` were created, each with a ``TF2`` prefix. +The previous enumerators are still available, but are now deprecated and will print a deprecation warning if used. +All code that uses the ``TF2Error`` enumerator should be updated to use the new ``TF2`` prefixed errors. +See https://github.com/ros2/geometry2/pull/349 for more details. + Known Issues ------------