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

geometry: Fix set of installed headers to be consistent #15066

Conversation

jwnimmer-tri
Copy link
Collaborator

@jwnimmer-tri jwnimmer-tri commented May 21, 2021

The installed headers are parsed by mkdoc to create pydrake docstrings.

When mkdoc scans an installed header that includes an uninstalled header, it results in a build failure, so we must be careful to only install headers that can be parsed. This is also cleaner for our users.

This ends up being a blocker for the bazel 4.1 upgrade.


This change is Reviewable

The installed headers are parsed by mkdoc to create pydrake docstrings.

When mkdoc scans an installed header that includes an uninstalled header, it
results in a build failure, so we must be careful to only install headers that
can be parsed.  This is also cleaner for our users.
@jwnimmer-tri jwnimmer-tri added priority: high status: single reviewer ok https://drake.mit.edu/reviewable.html labels May 21, 2021
@SeanCurtis-TRI
Copy link
Contributor

Have you seen #14792?

@jwnimmer-tri jwnimmer-tri marked this pull request as ready for review May 21, 2021 15:44
@jwnimmer-tri
Copy link
Collaborator Author

Nope, I had not. This PR definitely relates to that issue.

The changes there sound like better solutions, but this PR is sufficient to unblock me, and doesn't seem like it makes things worse?

+@SeanCurtis-TRI for both reviews, please.

@SeanCurtis-TRI
Copy link
Contributor

Alternatively, I can submit that solution directly in the next 30 minutes. We could swap roles and you could review it. Preference?

@jwnimmer-tri
Copy link
Collaborator Author

Either one is fine with me.

@SeanCurtis-TRI
Copy link
Contributor

I'm about 10 minutes out from submitting a PR.

@SeanCurtis-TRI
Copy link
Contributor

Can you confirm that #15070 unblocks you?

@jwnimmer-tri
Copy link
Collaborator Author

Replaced by #15070.

@jwnimmer-tri jwnimmer-tri deleted the geometry-headers-exclude branch May 21, 2021 18:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: high status: single reviewer ok https://drake.mit.edu/reviewable.html
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants