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.

Sign up for GitHub

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

Jump to bottom

Update patching guidelines #4759

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+3 −0
Open

Update patching guidelines #4759

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3bb4911
Update patching guidelines
premun Nov 26, 2024
1db83ea
Fix line length
premun Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Documentation/patching-guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ create one.
> git format-patch --zero-commit --no-signature -1 -o "$PATCH_DIR/<repo>"
> ```

**Note:** Please make sure there are no other already existing patches
Copy link
Member

Choose a reason for hiding this comment

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

Does this break synchronization? It has been necessary in the past.

Copy link
Member Author

Choose a reason for hiding this comment

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

It breaks the synchronization, we've only had it once. Why would it be necessary?

Copy link
Member

Choose a reason for hiding this comment

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

Why would it be necessary?

Historically there have been numerous times where a single file is touched by multiple patches. Patches are typically kept separate per the time they were made and their scope. This makes patch removal much easier as the backports flow in.

Can't get backport flow soon enough...

Copy link
Member Author

Choose a reason for hiding this comment

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

In which order would the patches be applied? Alphabetically? I know that the one case I mention was one patch adding a file and another patching it

Copy link
Member

Choose a reason for hiding this comment

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

alphabetically - that is why the numeric prefix is included in the guidelines.

which target same files as the newly added patch.

## Applying Patches

To apply a patch, or multiple patches, use `git am` while inside the target
Expand Down