-
Notifications
You must be signed in to change notification settings - Fork 252
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
Backport gz/sim.hh fix, add redirection header #1983
Conversation
Not all of the needed include paths are exported with the gz-sim target, so including the gz/sim.hh header doesn't work easily. This test fails to build and illustrates the problem. Signed-off-by: Steve Peters <scpeters@openrobotics.org>
Needed since the auto-generated header is gz/gazebo.hh Signed-off-by: Steve Peters <scpeters@openrobotics.org>
never mind I think it's being installed fine |
actually I think it's fine |
Codecov Report
@@ Coverage Diff @@
## ign-gazebo3 #1983 +/- ##
============================================
Coverage 78.04% 78.04%
============================================
Files 255 255
Lines 15080 15080
============================================
Hits 11769 11769
Misses 3311 3311 |
I think this will fix the abichecker build after it is merged, but the job currently fails in this PR when trying to compile the |
We have been in this situation before. I think we can override the ABI checker if we think everything else is okay. |
// Since gz-cmake derives the auto-generated header name from the cmake | ||
// project name, for ignition-gazebo*, the auto-generated header name | ||
// is <gz/gazebo.hh>. | ||
// This header file provides a redirection from <gz/sim.hh> to <gz/gazebo.hh> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we plan to have gz/gazebo.hh
in gz-sim that forwards to gz/sim.hh
? Otherwise, if users start using the header with ign-gazebo3
or ign-gazebo6
and then want to migrate to gz-sim, they will encounter build errors.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes, they would encounter build errors. I suppose we could add a gz/gazebo.hh
header that redirects to gz/sim.hh
and generates a deprecation warning when used
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it doesn't seem likely to me but it is possible
🦟 Bug fix
Backports #1978 and adds a missing header file
Summary
This backports a fix for using the
gz/sim.hh
header file, but this header file does not yet exist on theign-gazebo3
branch as a consequence of how gz-cmake derives the auto-generated header name from the cmake project name. For ignition-gazebo*, the auto-generated header name isgz/gazebo.hh
. Rather than try to modify gz-cmake, I've added a redirection header file fromgz/sim.hh
togz/gazebo.hh
for this branch. This should not be merged forward togz-sim*
. This is similar to the sdf/sdf.hh redirection header file used in SDFormat.Checklist
codecheck
passed (See contributing)Note to maintainers: Remember to use Rebase-and-merge.