Use IWYU pragma private to avoid IWYU trying to pull in sensor_msgs/impl/point_cloud2_iterator.hpp #298
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This adds `// IWYU pragma: private, include "sensor_msgs/point_cloud2_iterator.hpp" to the impl file. This allows the IWYU tool to know that it shouldn't try to pull in the impl file and should instead rely on the public header. See documentation here: https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-private Signed-off-by: Adam Leeper <[email protected]>
mjcarroll
approved these changes
Sep 26, 2025
|
LGTM, and it's just a comment (we don't run IWYU as part of CI), so I will skip CI here. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Note: this PR is related to addition of IWYU pragmas in generated messages, see ros2/rosidl#902.
This PR adds
// IWYU pragma: private, include "sensor_msgs/point_cloud2_iterator.hpp"to the impl file,sensor_msgs/impl/point_cloud2_iterator.hpp.This allows the IWYU tool to know that it shouldn't try to pull in the impl file and should instead rely on the public header.
See documentation here for IWYU pragma: private.
Is this user-facing behavior change?
Not user-facing in terms of code compilation or runtime.
Yes user-facing when using dev tools like IWYU:
sensor_msgs/point_cloud2_iterator.hpp.Did you use Generative AI?
No