Development using git:Creating patches: Difference between revisions
(Note that email functionality needs more than just the git package installed) |
(Specify were new aports should go and the repository dependencies.) |
||
Line 1: | Line 1: | ||
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). | 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). | ||
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 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. | |||
== Only the last commit with 'git send-email' == | == Only the last commit with 'git send-email' == |
Revision as of 07:32, 6 February 2019
Patches should be created with git and submitted to alpine-aports mailing list with git send-email (which needs the git-email Alpine package).
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 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.
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
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
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]
- ...
- [PATCH 2/m]
- [PATCH 1/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 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:
... 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.