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

Remove deprecations: tock #1091

Merged
merged 4 commits into from
Dec 16, 2024
Merged

Remove deprecations: tock #1091

merged 4 commits into from
Dec 16, 2024

Conversation

caguero
Copy link
Contributor

@caguero caguero commented Dec 5, 2024

🦟 Bug fix

Perform the tock of the tick-tock cycle and remove / move deprecated code.

Summary

Checklist

  • Signed all commits for DCO
  • Added tests
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • Consider updating Python bindings (if the library has them)
  • codecheck passed (See contributing)
  • All tests passed (See test coverage)
  • While waiting for a review on your PR, please help review another open pull request to support the maintainers

Note to maintainers: Remember to use Squash-Merge and edit the commit message to match the pull request summary while retaining Signed-off-by messages.

Signed-off-by: Carlos Agüero <[email protected]>
@caguero caguero requested a review from iche033 as a code owner December 5, 2024 20:44
Migration.md Outdated Show resolved Hide resolved
Co-authored-by: Ian Chen <[email protected]>
Signed-off-by: Carlos Agüero <[email protected]>
@@ -151,8 +151,6 @@ endif()
set(GZ_RENDERING_ENGINE_RELATIVE_INSTALL_DIR
${GZ_LIB_INSTALL_DIR}/gz-${GZ_DESIGNATION}-${PROJECT_VERSION_MAJOR}/engine-plugins
)
set(GZ_RENDERING_ENGINE_INSTALL_DIR
${CMAKE_INSTALL_PREFIX}/${GZ_RENDERING_ENGINE_RELATIVE_INSTALL_DIR})
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we may still need to keep this cmake variable here as I see that these are being used in ogre/src/CMakeLists.txt and ogre2/src/CMakeLists.txt

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we replace these calls with getResourcePath()?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

getResourcePath() is a C++ function so we won't be able to replace those calls in CMakeLists.txt. I think we can just keep this cmake var here. Other changes in this PR are fine.

Copy link
Contributor Author

@caguero caguero Dec 9, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I meant GZ_RENDERING_RESOURCE_PATH, that it's used in some .cc files (although also in optix/src/CMakeLists.txt).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh do you see the macro used in cc files? For example, I see usage like this that it just gets the value directly from the GZ_RENDERING_RESOURCE_PATH environment variable (instead of the macro from config.hh).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to clarify, I think we are still keeping the environment variable and only deprecating the macro? Or are we deprecating / removing both?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for the confusion. I think what we want is to remove just the GZ_RENDERING_RESOURCE_PATH macro and nothing else. We'll keep supporting the environment variables. 6bd5db5

Signed-off-by: Carlos Agüero <[email protected]>
Migration.md Outdated
@@ -12,9 +12,6 @@ release will remove the deprecated code.
1. The macro `GZ_RENDERING_RESOURCE_PATH` is removed. Use
`gz::rendering::getResourcePath()` instead.

1. The macro `GZ_RENDERING_ENGINE_INSTALL_DIR` is removed. Use
`gz::rendering::getEngineInstallDir()` instead.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So a little confusing but there are 3 forms of GZ_RENDERING_ENGINE_INSTALL_DIR

  • cmake variable in CMakeLists.txt
  • C++ macro in config.hh.in
  • environment variable

We removed the C++ macro (and kept the other two). So we can keep this entry in Migration.md

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right, thanks. c383af1

Signed-off-by: Carlos Agüero <[email protected]>
@iche033 iche033 merged commit f5dbc9d into main Dec 16, 2024
9 of 10 checks passed
@iche033 iche033 deleted the caguero/10_tock branch December 16, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants