Skip to content

Backport: Don't include the gz/math.hh header from library code (#1043) #1044

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

Closed
wants to merge 1 commit into from

Conversation

azeey
Copy link
Collaborator

@azeey azeey commented Jun 7, 2022

Backport of #1043 with additional changes for the ignition -> gz rename.

Note to maintainers: Remember to Merge with commit (not squash-merge or rebase)

🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸🔸

Using overly-broad include statements leads to slower builds and
bloated object code.

Signed-off-by: Jeremy Nimmer <[email protected]>
@azeey azeey requested a review from scpeters as a code owner June 7, 2022 17:32
@github-actions github-actions bot added Gazebo 1️1️ Dependency of Gazebo classic version 11 🏰 citadel Ignition Citadel labels Jun 7, 2022
@scpeters
Copy link
Member

scpeters commented Jun 7, 2022

we should make sure that gazebo11 and ignition-citadel packages still compile with this change

@codecov
Copy link

codecov bot commented Jun 7, 2022

Codecov Report

Merging #1044 (8b1d800) into sdf9 (a428e2a) will increase coverage by 44.11%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##             sdf9    #1044       +/-   ##
===========================================
+ Coverage   43.47%   87.59%   +44.11%     
===========================================
  Files           1       64       +63     
  Lines          23    10061    +10038     
===========================================
+ Hits           10     8813     +8803     
- Misses         13     1248     +1235     
Impacted Files Coverage Δ
include/sdf/Param.hh 75.80% <ø> (ø)
src/parser_urdf.cc 83.25% <ø> (ø)
test_config.h
src/SDFExtension.cc 49.43% <0.00%> (ø)
src/Noise.cc 98.14% <0.00%> (ø)
src/Sensor.cc 77.70% <0.00%> (ø)
src/Magnetometer.cc 100.00% <0.00%> (ø)
src/Collision.cc 87.95% <0.00%> (ø)
src/Joint.cc 92.13% <0.00%> (ø)
src/ForceTorque.cc 89.38% <0.00%> (ø)
... and 57 more

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 a428e2a...8b1d800. Read the comment docs.

@azeey
Copy link
Collaborator Author

azeey commented Jun 7, 2022

we should make sure that gazebo11 and ignition-citadel packages still compile with this change

Good point. I tested with citadel and there were some build failures in gazebo (gz-sim). Should I fix those or is this change not backportable?

@scpeters
Copy link
Member

scpeters commented Jun 7, 2022

we should make sure that gazebo11 and ignition-citadel packages still compile with this change

Good point. I tested with citadel and there were some build failures in gazebo (gz-sim). Should I fix those or is this change not backportable?

let's start by fixing any bugs we find, and then we can decided on whether to backport

@scpeters
Copy link
Member

scpeters commented Jun 9, 2022

gazebo11 needs some changes: gazebosim/gazebo-classic#3227

#include <ignition/math/Pose3.hh>
#include <ignition/math/Quaternion.hh>
#include <ignition/math/Vector2.hh>
#include <ignition/math/Vector3.hh>
Copy link
Contributor

Choose a reason for hiding this comment

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

Even though this is the right thing to do, we should minimize the chances of breaking downstream users on a stable version. That's why we decided to target gazebosim/gz-transport#315 at Garden for example - that specific include change will definitely break lots of users. Here it could be argued that Param.hh is not as widely used as Node.hh, but I think the same principle applies.

@scpeters
Copy link
Member

scpeters commented Jul 7, 2022

this may break downstream code, so let's skip it

@scpeters scpeters closed this Jul 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🏰 citadel Ignition Citadel Gazebo 1️1️ Dependency of Gazebo classic version 11
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants