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

Deprecate utilities in favor of ign-utils #233

Merged
merged 2 commits into from
Apr 13, 2022
Merged

Conversation

chapulina
Copy link
Contributor

🎉 New feature

Summary

  • Added pragma messages that are printed on compilation to warn users
  • Removed tests so that we don't get the messages. I wasn't sure how to suppress the message otherwise, and I think that we're fairly confident that the feature works as intended at this point.

Test it

You can restore the test and compile to see the warning, for example:

$ colcon build --cmake-args="-DBUILD_TESTING=true" --packages-select-regex=.*n-cmake
Starting >>> ignition-cmake3
--- stderr: ignition-cmake3                              
In file included from /home/chapulina/dev_focal/ws_fortress/src/ign-cmake/test/warning/nonvirtual_destructor.cc:20:
/home/chapulina/dev_focal/ws_fortress/src/ign-cmake/include/ignition/utilities/SuppressWarning.hh:23:85: note: #pragma message: ign-cmake (utilities) SuppressWarning is deprecated, use ign-utils
   23 | #pragma message("ign-cmake (utilities) SuppressWarning is deprecated, use ign-utils")
      |                                                                                     ^
---
Finished <<< ignition-cmake3 [0.52s]

Checklist

  • Signed all commits for DCO
  • Added Removed tests
  • Added example and/or tutorial
  • Updated documentation (as needed)
  • Updated migration guide (as needed)
  • 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: Louise Poubel <louise@openrobotics.org>
Signed-off-by: Louise Poubel <louise@openrobotics.org>
@chapulina chapulina requested a review from mjcarroll April 13, 2022 18:57
@chapulina chapulina added the 🌱 garden Ignition Garden label Apr 13, 2022
@chapulina chapulina linked an issue Apr 13, 2022 that may be closed by this pull request
@scpeters
Copy link
Member

the #pragma messages may show up in colcon, but jenkins doesn't seem to recognize them as compiler warnings:

In file included from /usr/include/ignition/cmake3/ignition/utilities/detail/ExtraTestMacros.hh:21,
                 from /usr/include/ignition/cmake3/ignition/utilities/ExtraTestMacros.hh:21,
                 from /home/jenkins/workspace/ignition_rendering-ci-pr_any-ubuntu_auto-amd64/ign-rendering/src/Heightmap_TEST.cc:22:
/usr/include/ignition/cmake3/ignition/utilities/SuppressWarning.hh:23:85: note: #pragma message: ign-cmake (utilities) SuppressWarning is deprecated, use ign-utils
   23 | #pragma message("ign-cmake (utilities) SuppressWarning is deprecated, use ign-utils")
      |                                                                                     ^
In file included from /home/jenkins/workspace/ignition_rendering-ci-pr_any-ubuntu_auto-amd64/ign-rendering/src/Heightmap_TEST.cc:22:
/usr/include/ignition/cmake3/ignition/utilities/ExtraTestMacros.hh:23:85: note: #pragma message: ign-cmake (utilities) ExtraTestMacros is deprecated, use ign-utils
   23 | #pragma message("ign-cmake (utilities) ExtraTestMacros is deprecated, use ign-utils")
      |                                                                                     ^

@chapulina
Copy link
Contributor Author

Good catch, see

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Deprecate utilities in favor of ign-utils
3 participants