Creating patches: Difference between revisions

Latest revision as of 19:21, 5 October 2025

This page documents the ways to propose changes to packages in Alpine Linux aports as a patch. Patches can be currently submitted via Gitlab only. Creating and submitting patches is one of the most effective way to contribute to Alpine Linux.

If you want to create a new package, refer Creating an Alpine package page.

Submitting patches via Gitlab

Set up Gitlab account first, if not already done.
Fork the aports repository, if you want to open a merge request for aports.
After forking, clone the forked repository.
Create and switch to a new branch e.g. name of the package you want to edit.
Do all your changes in the above branch and commit your work.

Creating a merge request

To create a Merge Request, push your changes to your fork, as follows:
git push -u origin $branchname
Gitlab will usually print a URL to create a Merge Request in your terminal.
Open that URL in your browser, follow the instructions to complete the Merge Request creation.

Amending changes to a merge request

If reviewers requested changes or if you noticed that something should be changed about your merge request's change you can simply amend your changes to the right commit and force push. So if you want to change the commit at the tip of your branch you can simply do:

git commit --amend

If you want to change a commit that's not at the tip of your branch you can do:

git commit --fixup $SHA1_OF_COMMIT_YOU_WANT_TO_FIX

Afterwards you have to force-push in order to update your merge request:

git push -f origin

Submitting patches via the mailing list

Warning: Submitting patches via the mailing list is currently broken.

Patches should be created with git and submitted to alpine-aports mailing list with git send-email (which needs the git-email Alpine package).

Only the last commit with 'git send-email'

To submit the last commit as a patch to alpine-aports mailing list:

git send-email --to alpine-aports@lists.alpinelinux.org -1

Tip: You save the To-address (does not require '--to alpine-aports@lists.alpinelinux.org') in the git config with:

git config sendemail.to alpine-aports@lists.alpinelinux.org

The first line in commit message will be subject and the long description (separated with empty line) will be the body in the email. The example below shows

testing/packagename: new aport <- header

https://example.com/packagename <- body
wonderful package

Note: The git send-email command is provided by the git-email package (git-perl in v2.7 and older).

See Development using git#Email_configuration on how configure SMTP Auth.

Multiple commits with 'git send-email'

If you have many commits you can create a directory with patches and send them with git send-email.

rm -Rf patches mkdir patches git format-patch -o patches origin git send-email patches --compose --no-chain-reply-to --to alpine-aports@lists.alpinelinux.org

You can also format patches for the last x number of commits with:

git format-patch -x -o patches

This will produce the patches for each local commit in the directory "patches" and send them. Use --no-chain-reply-to to avoid that each patch is sent as a reply to the previous patch.

Eg.

[PATCH 0/m]
- [PATCH 1/m]
  - [PATCH 2/m]
    - ...

With the option --no-chain-reply-to the patches will be sent as a reply to the first email, the cover letter (the [PATCH 0/m]) and will make the email thread nicer. Like this:

[PATCH 0/m]
- [PATCH 1/m]
- [PATCH 2/m]
- ..

Resend an updated patch

Sometimes patches are rejected due to minor issues in the patch. Do not send an incremental patch on top of your initial, bad, patch. Instead, recreate the patch and send a new, fixed version of your patch. (use git commit --amend to edit a local commit).

When you sending a second version of the patch use --subject-prefix "PATCH v2" to indicate that this is a new version of a previously sent patch. You may also use --in-reply-to <message-id> where <message-id> the the id of email requesting the resend.

You should also write a note on what was changed. Use --annotate for this and write the comment under the three dashes "---" so the note is not included in the commit message. For example:

...
Subject: [PATCH v2] testing/mypackage: new aport

https://example.com
Example package
---
Changes v1 -> v2:
 - removed depends
 - added zlib-dev to makedepends

 testing/mypackage/APKBUILD | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 testing/mypackage/APKBUILD
...

Note that the notes that are below the "---" will not be included in the commit message.

@@ Line 1: / Line 1: @@
-New aports should normally go into testing repository. After a reasonable testing period if the package is complete (e.g. it has an init script, it has a working and sane default configuration, etc.) and it has a maintainer it can be moved into community repository. Main repository is for packages that are either core of the linux system or are dependencies of other core packages. A package in main cannot have a dependency in community or testing and a package in community cannot have a dependency on packages in testing.
+This page documents the ways to propose changes to packages in Alpine Linux [https://gitlab.alpinelinux.org/alpine/aports aports] as a patch. Patches can be currently submitted [[#Submitting patches via Gitlab|via Gitlab]] only.  Creating and submitting patches is one of the most effective way to [[Alpine_Linux:Contribute|contribute]] to Alpine Linux.
-There are currently two ways to contribute to propose changes, via Gitlab and via the mailing list.
+If you want to create a new package, refer [[Creating an Alpine package]] page.
 == Submitting patches via Gitlab ==
-=== Setup ===
+* [[Git#Setup gitlab account|Set up Gitlab account]] first, if not already done.
+* [[Git#Forking a repository|Fork the aports repository]], if you want to open a merge request for aports.
-To submit patches on [https://gitlab.alpinelinux.org Alpine Linux' Gitlab instance] you first have to create an account for it [https://gitlab.alpinelinux.org/users/sign_in here]. It's recommended to set a SSH key now, refer to the [https://docs.gitlab.com/ee/ssh/ Gitlab docs] for how to do that.
+* After forking, [[Git#Cloning_your_forked_repository|clone the forked repository]].
+* [[Git#Change_to_another_branch|Create and switch to a new branch]] e.g. name of the package you want to edit.
+* Do all your changes in the above branch and [[Git#Commit|commit]] your work.
 === Creating a merge request ===
-Now that you're all setup you have to fork the repository you want to contribute to, for example if you want to open a merge request for aports you would have to fork [https://gitlab.alpinelinux.org/alpine/aports alpine/aports], see the [https://docs.gitlab.com/ee/user/project/repository/forking_workflow.html#creating-a-fork Gitlab docs] if you're having problems with that. Other repositories belonging to Alpine Linux live in the [https://gitlab.alpinelinux.org/alpine Alpine organisation]. If you already have an old fork, first clone it and then update it as shown below.
+* To create a Merge Request, push your changes to your fork, as follows:{{Cmd|git push -u origin $branchname}}
+* Gitlab will usually print a URL to create a Merge Request in your terminal.
-After forking you can clone the repository like so:
+* Open that URL in your browser, follow the instructions to complete the Merge Request creation.
-{{Cmd|git clone git@gitlab.alpinelinux.org:$USER/$REPO.git}}
-Replace $USER with the nickname of your Gitlab account and $REPO with the repository you want to work on. Now you can change to another branch (e.g. the name of the package you want to edit) with:
-(If necessary, update an old fork first, see [[#Rebasing against Alpine Linux's master|rebasing]], below)
-{{Cmd|git checkout -b pkgname}}
-Do your changes now and then push with:
-{{Cmd|git push -u origin $branchname }}
-Gitlab will print an URL to create a merge request in your terminal.
 === Amending changes to a merge request ===
-If reviewers requested changes or if you noticed that something should be changed about your merge request's change you can simply amend your changes to the right commit and force push. So if you want to change the commit at the tip of your branch you can simply do:
+If reviewers requested changes or if you noticed that something should be changed about your merge request's change you can simply amend your changes to the right commit and force push. So if you want to change the commit at the tip of your branch you can simply do: {{Cmd|git commit --amend}}
-{{Cmd|git commit --amend}}
+If you want to change a commit that's not at the tip of your branch you can do: {{Cmd|git commit --fixup $SHA1_OF_COMMIT_YOU_WANT_TO_FIX}}
-If you want to change a commit that's not at the tip of your branch you can do:
+Afterwards you have to force-push in order to update your merge request: {{Cmd|git push -f origin}}
-{{Cmd|git commit --fixup $SHA1_OF_COMMIT_YOU_WANT_TO_FIX}}
+== Submitting patches via the mailing list ==
-Afterwards you have to force-push in order to update your merge request:
-{{Cmd|git push -f origin}}
-=== Rebasing against Alpine Linux's master ===
-It's best to always stay up-to-date with the state of the upstream Alpine Linux repository to ensure that no merge conflicts happen later on. To do that you first have to add a new git remote which points to the upstream repository (instead of your fork):
-{{Cmd|git remote add upstream https://gitlab.alpinelinux.org/alpine/$REPO}}
-Now you can fetch all changes with:
-{{Cmd|git fetch --all}}
+{{Warning|Submitting patches via the mailing list is currently broken.}}
-And then you can rebase with:
-{{Cmd|git rebase}}
-== Submitting patches via the mailing list ==
-{{Warning|Submitting patches via the mailing list is currently broken as-of 15 August 2023}}
 Patches should be created with git and submitted to [mailto:alpine-aports@lists.alpinelinux.org alpine-aports] mailing list with ''git send-email'' (which needs the ''git-email'' Alpine package).
@@ Line 116: / Line 85: @@
 When you sending a second version of the patch use '''--subject-prefix "PATCH v2"''' to indicate that this is a new version of a previously sent patch. You may also use '''--in-reply-to <message-id>''' where <message-id> the the id of email requesting the resend.
-You should also write a note on the what was changed. Use '''--annotate''' for this and write the comment under the three dashes "---" so the note is not included in the commit message. For example:
+You should also write a note on what was changed. Use '''--annotate''' for this and write the comment under the three dashes "---" so the note is not included in the commit message. For example:
 <pre>
 ...