Deprecate GZ_PHYSICS_ENGINE_INSTALL_DIR

Signed-off-by: Carlos Agüero <[email protected]>
gazebosim · Dec 8, 2024 · 97f5255 · 97f5255
1 parent f993aab
commit 97f5255
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -97,6 +97,9 @@ message(STATUS "-------------------------------------------\n")
 set(GZ_PHYSICS_ENGINE_RELATIVE_INSTALL_DIR
   ${GZ_LIB_INSTALL_DIR}/gz-${GZ_DESIGNATION}-${PROJECT_VERSION_MAJOR}/engine-plugins
 )
+set(GZ_PHYSICS_ENGINE_INSTALL_DIR
+  ${CMAKE_INSTALL_PREFIX}/${GZ_PHYSICS_ENGINE_RELATIVE_INSTALL_DIR}
+)
 
 #============================================================================
 # Configure the build

diff --git a/Migration.md b/Migration.md
@@ -7,9 +7,9 @@ release will remove the deprecated code.
 
 ## Gazebo Physics 8.X to 9.X
 
-### Removals
+### Deprecations
 
-* The environment variable `GZ_PHYSICS_ENGINE_INSTALL_DIR` is removed. Use
+* The macro `GZ_PHYSICS_ENGINE_INSTALL_DIR` is deprecated. Use
 `gz::physics::getEngineInstallDir()` instead.
 
 ## Gazebo Physics 5.X to 6.X

diff --git a/include/gz/physics/config.hh.in b/include/gz/physics/config.hh.in
@@ -29,6 +29,8 @@
 #define GZ_PHYSICS_VERSION_FULL "${PROJECT_VERSION_FULL}"
 #define GZ_PHYSICS_VERSION_NAMESPACE v${PROJECT_VERSION_MAJOR}
 
+#define GZ_PHYSICS_ENGINE_INSTALL_DIR _Pragma ("GCC warning \"'GZ_PHYSICS_ENGINE_INSTALL_DIR' macro is deprecated, use gz::physics::getEngineInstallDir() function instead. \"") "${GZ_PHYSICS_ENGINE_INSTALL_DIR}"
+
 #define GZ_PHYSICS_VERSION_HEADER "Gazebo Physics, version ${PROJECT_VERSION_FULL}\nCopyright (C) 2017 Open Source Robotics Foundation.\nReleased under the Apache 2.0 License.\n\n"
 
 #endif