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

Add a framework for issuing deprecation messages (#429) #538

Merged

Conversation

KyleFromKitware
Copy link
Collaborator

@KyleFromKitware KyleFromKitware commented Nov 2, 2022

This adds two new commands, tribits_deprecated() for issuing generic deprecation messages, and tribits_deprecated_command() for deprecating functions and macros.

Addresses #429

@bartlettroscoe bartlettroscoe changed the title Add a framework for issuing deprecation messages Add a framework for issuing deprecation messages (#429) Nov 2, 2022
Copy link
Member

@bartlettroscoe bartlettroscoe left a comment

Choose a reason for hiding this comment

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

@KyleFromKitware, thanks for adding this PR so fast! In addition to the suggestions below, I have just a few other requests:

  • Please add entries for these new functions to the file tribits/doc/guides/UtilsMacroFunctionDocTemplate.rst (which is my poor-man's Doxygen for CMake code).'

  • Please add the cache var TRIBITS_HANDLE_TRIBITS_DEPRECATED_CODE for the TriBITS framework to the (large) macro tribits_define_global_options_and_define_extra_repos() (We will pull that macro out into its own module at some point here and even break it up into multiple modules depending on how we want to componentize TriBITS as per Exposing parts of TriBITS as CMake modules #368.)

tribits/core/utils/TribitsDeprecatedHelpers.cmake Outdated Show resolved Hide resolved
test/core/TestingFunctionMacro_UnitTests.cmake Outdated Show resolved Hide resolved
This adds two new commands, tribits_deprecated() for issuing generic
deprecation messages, and tribits_deprecated_command() for deprecating
functions and macros.
Copy link
Member

@bartlettroscoe bartlettroscoe left a comment

Choose a reason for hiding this comment

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

@KyleFromKitware, thanks for the changes! I think this PR is good to merge.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants