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

Packaging Practices should have a section on making a patch #396

Open
EbonJaeger opened this issue Oct 3, 2023 · 1 comment
Open

Packaging Practices should have a section on making a patch #396

EbonJaeger opened this issue Oct 3, 2023 · 1 comment

Comments

@EbonJaeger
Copy link
Member

The current documentation only covers applying a patch, which is of little help if the packager doesn't first know how to make a patch file in the first place.

The section should include the following steps:

  1. Clone the source repository
  2. Make changes to the source
  3. Create the patch file
    i. Create a git commit detailing the changes
    ii. Create (if not exists) the files directory inside the package's directory
    iii. Run git format-patch -o ~/path/to/package/dir/files to create the patch file
@Staudey
Copy link
Member

Staudey commented Feb 27, 2024

Adding Reilly's suggested improvement here before I forget:

If you use git format-patch with the arguments --zero-commit and --no-signature it'll zero out the commit hash and strip the git version from the bottom
This can help reduce the diff from updating the patches in the future a bit

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

2 participants