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

[workspace] Reorganize patches headed to upstream #22052

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jwnimmer-tri
Copy link
Collaborator

@jwnimmer-tri jwnimmer-tri commented Oct 16, 2024

This change is Reviewable

@jwnimmer-tri jwnimmer-tri added priority: low release notes: none This pull request should not be mentioned in the release notes labels Oct 16, 2024
@jwnimmer-tri jwnimmer-tri mentioned this pull request Oct 16, 2024
7 tasks
@jwnimmer-tri
Copy link
Collaborator Author

+@rpoyner-tri and +@SeanCurtis-TRI for reviews, please.

Copy link
Contributor

@rpoyner-tri rpoyner-tri left a comment

Choose a reason for hiding this comment

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

:lgtm:

Reviewed 107 of 107 files at r1, all commit messages.
Reviewable status: 1 unresolved discussion, LGTM missing from assignee SeanCurtis-TRI(platform)


tools/workspace/clarabel_cpp_internal/patches/sdp.patch line 4 at r1 (raw file):

Reasoning for not upstreaming this patch: changing an option, which is
our perogative but not relevant for upstream.

typo

Suggestion:

prerogative

Copy link
Contributor

@rpoyner-tri rpoyner-tri left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r2, all commit messages.
Reviewable status: LGTM missing from assignee SeanCurtis-TRI(platform)

Copy link
Contributor

@SeanCurtis-TRI SeanCurtis-TRI left a comment

Choose a reason for hiding this comment

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

:LGTM: With the following caveat:

I didn't go through and confirm consistency and correctness (i.e., were files not put in upstream that should be or vice versa). I'm relying on CI to report that the files that did move and their application in repository.bzl is consistent.

Let me know if a deeper independent survey is required from platform review.

(All I have is some questions on the guidance in README.md.)

Reviewed 106 of 107 files at r1, 1 of 1 files at r2, all commit messages.
Reviewable status: 2 unresolved discussions


tools/workspace/README.md line 196 at r2 (raw file):

When we need to adjust an upstream source release for our purposes, we do that
with `*.patch` files in Drake, not by forking the repository and pointing to
the fork.

In this PR you've provided a bunch of reasons for why patches are not included in the upstream directory. Is that something we want to actively encourage? If so, something should probably be said here.


tools/workspace/README.md line 201 at r2 (raw file):

change should be upstreamed (even if we haven't filed that pull request yet),
put the patch in tools/workspace/foobar/patches/upstream/quux.patch to make
it easier to search for patches that require follow-up action.

It's not clear to me what the guiding rule is when it comes to upstream. Should it go in upstream if we feel the patch as is should be upstreamed. Or some behavior akin to the patch should be upstreamed. For example, civil_time_linkopts.patch explicitly says that as patches go, it's fine for Drake, but upstream would require something different.

So, perhaps the instructions should elaborate a bit more on this nuance.

Copy link
Collaborator Author

@jwnimmer-tri jwnimmer-tri left a comment

Choose a reason for hiding this comment

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

I didn't go through and confirm consistency and correctness (i.e., were files not put in upstream that should be or vice versa).

Hopefully Rico did that to some degree. Anyway, it probably doesn't need to be perfect. Getting it 80% right is still an improvement.

Reviewable status: 2 unresolved discussions


tools/workspace/README.md line 196 at r2 (raw file):

Previously, SeanCurtis-TRI (Sean Curtis) wrote…

In this PR you've provided a bunch of reasons for why patches are not included in the upstream directory. Is that something we want to actively encourage? If so, something should probably be said here.

Done.


tools/workspace/README.md line 201 at r2 (raw file):

Previously, SeanCurtis-TRI (Sean Curtis) wrote…

It's not clear to me what the guiding rule is when it comes to upstream. Should it go in upstream if we feel the patch as is should be upstreamed. Or some behavior akin to the patch should be upstreamed. For example, civil_time_linkopts.patch explicitly says that as patches go, it's fine for Drake, but upstream would require something different.

So, perhaps the instructions should elaborate a bit more on this nuance.

Done.

Copy link
Contributor

@rpoyner-tri rpoyner-tri left a comment

Choose a reason for hiding this comment

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

Reviewed 1 of 1 files at r3, all commit messages.
Reviewable status: 2 unresolved discussions

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority: low release notes: none This pull request should not be mentioned in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants