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

Replace custom SDF_* macros with GZ_* #1067

Merged
merged 5 commits into from
Jul 19, 2022
Merged

Conversation

scpeters
Copy link
Member

@scpeters scpeters commented Jul 6, 2022

🎉 New feature

Reduce duplicate macro definitions

Summary

Replace custom implementation of SDF_DEPRECATED and SDF_SUPPRESS_DEPRECATED_* macros with the GZ_* macro counterparts.

Test it

Remove the SDF_SUPPRESS_* lines in InterfaceElements.cc and compile to confirm that SDF_DEPRECATED macro still works.

Checklist

  • Signed all commits for DCO
  • Added tests
  • Added example and/or tutorial
  • 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.

Replace custom implementation of SDF_DEPRECATED and
SDF_SUPPRESS_DEPRECATED_* macros with the GZ_* macro
counterparts.

Signed-off-by: Steve Peters <[email protected]>
@scpeters scpeters requested a review from chapulina July 6, 2022 23:19
@scpeters scpeters requested a review from azeey as a code owner July 6, 2022 23:19
@github-actions github-actions bot added the 🌱 garden Ignition Garden label Jul 6, 2022
@scpeters
Copy link
Member Author

scpeters commented Jul 6, 2022

windows CI doesn't like this

@codecov
Copy link

codecov bot commented Jul 6, 2022

Codecov Report

Merging #1067 (dae1ffb) into main (fa0ae4a) will not change coverage.
The diff coverage is n/a.

❗ Current head dae1ffb differs from pull request most recent head b7b0684. Consider uploading reports for the commit b7b0684 to get more accurate results

@@           Coverage Diff           @@
##             main    #1067   +/-   ##
=======================================
  Coverage   83.14%   83.14%           
=======================================
  Files         154      154           
  Lines       18724    18724           
=======================================
  Hits        15568    15568           
  Misses       3156     3156           
Impacted Files Coverage Δ
include/sdf/InterfaceElements.hh 75.00% <ø> (ø)
include/sdf/Types.hh 100.00% <ø> (ø)
src/InterfaceElements.cc 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fa0ae4a...b7b0684. Read the comment docs.

@scpeters scpeters changed the title Use GZ_* macros to define custom SDF_* macros Replace custom SDF_* macros with GZ_* Jul 7, 2022
@chapulina chapulina requested a review from ahcorde July 18, 2022 18:53
@@ -169,57 +170,57 @@ class SDFORMAT_VISIBLE NestedInclude
/// not end with a file extension (it will not end with an extension if it
/// refers to a model package).
/// \deprecated Use NestedInclude::Uri() instead
public: std::string uri SDF_DEPRECATED(12);
public: GZ_DEPRECATED(12) std::string uri;
Copy link
Contributor

Choose a reason for hiding this comment

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

Should these say 13?

Copy link
Member Author

Choose a reason for hiding this comment

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

oh, these were actually deprecated in fortress; I suppose they can be removed here. Do you mind if I do that in a separate pull request?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh yeah I didn't pay attention to the diff. SGTM

@scpeters scpeters merged commit 0c218aa into main Jul 19, 2022
@scpeters scpeters deleted the scpeters/more_gz_macros branch July 19, 2022 01:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌱 garden Ignition Garden
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants