Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
| submitting-patches [2021/12/05 10:29] – [1. Creating a patch] formatting vgaetera | submitting-patches [2024/06/17 08:59] – old revision restored (2024/01/03 07:44) svanheule | ||
|---|---|---|---|
| Line 8: | Line 8: | ||
| * **Patches to core packages and patches that add support for new devices** (i.e. code that is in [[https:// | * **Patches to core packages and patches that add support for new devices** (i.e. code that is in [[https:// | ||
| - | * **Patches for Luci web interface and related packages** can be submitted to mailing list or to the [[https:// | + | * **Patches for LuCI web interface and related packages** can be submitted to mailing list or to the [[https:// |
| - | * **Patches for community packages about routing** should go as a Github PR in the [[https:// | + | * **Patches for community packages about routing** should go as a Github PR in the [[https:// |
| - | * **Patches for community packages about telephony and SIP/VOIP** should go as a Github PR in the [[https:// | + | * **Patches for community packages about telephony and SIP/VOIP** should go as a Github PR in the [[https:// |
| - | * **Patches for miscellaneous community packages** should go as a Github PR in the [[https:// | + | * **Patches for miscellaneous community packages** should go as a Github PR in the [[https:// |
| <WRAP round info 60%> | <WRAP round info 60%> | ||
| Line 48: | Line 48: | ||
| * **all commits must contain '' | * **all commits must contain '' | ||
| - | * GitHub web interface or GUI application for git: you must append | + | * GitHub web interface or GUI application for git: you must append the '' |
| * git command-line interface: | * git command-line interface: | ||
| Line 70: | Line 70: | ||
| - PRs can be sent to the patches mailing list from any source and will always be considered for inclusion if the quality of the tree is good and format of submission is correct | - PRs can be sent to the patches mailing list from any source and will always be considered for inclusion if the quality of the tree is good and format of submission is correct | ||
| - Staging trees can be hosted as part of the projects git infrastructure, | - Staging trees can be hosted as part of the projects git infrastructure, | ||
| + | ===== Patch backports ===== | ||
| + | Backporting refers to applying changes to a stable (release) branch like for example **openwrt-23.05** from the **main** branch. Since new features are not added to stable branches, backported changes are generally bug fixes and security fixes only. The process is roughly following: | ||
| + | - Changes needs to be first applied into the **main** branch | ||
| + | - Afterwards those changes can be proposed to be applied into the stable (release) branch | ||
| + | When pulling the commits from the **main** branch, you need to use '' | ||
| + | <code bash> | ||
| + | $ git cherry-pick --signoff -x < | ||
| + | </ | ||
| ===== Patch checklist ===== | ===== Patch checklist ===== | ||
| - Single commit ( multiple commits must first be squashed, as described [[docs: | - Single commit ( multiple commits must first be squashed, as described [[docs: | ||
| Line 96: | Line 103: | ||
| Based on [[https:// | Based on [[https:// | ||
| - | OpenWrt is constantly being improved. We'd like as many people to contribute to this as we can get. If you find a change useful, by all means try to get it incorporated into the project. This should improve OpenWrt and it should help carry your changes forward into future versions | + | OpenWrt is constantly being improved. We'd like as many people to contribute to this as we can get. If you find a change useful, by all means try to get it incorporated into the project. This should improve OpenWrt and it should help carry your changes forward into future versions. |
| For a person or company who wishes to submit a change to OpenWrt, the process can sometimes be daunting if you're not familiar with "the system." | For a person or company who wishes to submit a change to OpenWrt, the process can sometimes be daunting if you're not familiar with "the system." | ||
| - | |||
| - | This document tries to lay out a procedure to enable people to submit patches in a way that is most effective for all concerned. | ||
| It is important to do all these steps repeatedly: | It is important to do all these steps repeatedly: | ||
| * Listen to what other people think. | * Listen to what other people think. | ||
| - | * Talk explaining | + | * Explain |
| - | * Do write useful patches including documentation. | + | * Write useful patches including documentation. |
| * Test, test, test. | * Test, test, test. | ||
| Where to listen and talk: | Where to listen and talk: | ||
| * Google to find things related to your problem | * Google to find things related to your problem | ||
| - | * Wiki: check this [[: | + | * [[: |
| - | * Mailing Lists | + | * [[: |
| - | * Forums like [[https:// | + | * [[: |
| - | * IRC irc.freenode.net, | + | * [[https:// |
| - | * TRAC https:// | + | * GitHub - https:// |
| - | * GitHub - http:// | + | * (archived) |
| ===== Documentation ===== | ===== Documentation ===== | ||
| Line 143: | Line 148: | ||
| * diff | * diff | ||
| - | To ease integration of smaller patches into trunk, developers can also make pull-requests into the GitHub trunk tree - this is an addition over the earlier patchwork workflow. Larger patches, or patches that require further discussion, should still be sent to the openwrt-devel list, where they' | + | To ease integration of smaller patches into trunk, developers can also make pull-requests into the GitHub trunk tree - this is an addition over the earlier patchwork workflow. |
| + | Larger patches, or patches that require further discussion, should still be sent to the **openwrt-devel** list, where they' | ||
| ==== 2. Describe your changes ===== | ==== 2. Describe your changes ===== | ||
| Line 191: | Line 197: | ||
| Large changes are not appropriate for mailing lists, and some maintainers. If your patch, uncompressed, | Large changes are not appropriate for mailing lists, and some maintainers. If your patch, uncompressed, | ||
| - | ==== 8. Don't get discouraged, re-submit ===== | + | ==== 8. Remain objective, re-submit ===== |
| + | |||
| + | It's nothing personal. Code should work well for its intended purpose and results should adhere to many standards and requirements, | ||
| After you have submitted your change, be patient and wait. If developers like your change and apply it, it will appear as new revision in the source code management system. | After you have submitted your change, be patient and wait. If developers like your change and apply it, it will appear as new revision in the source code management system. | ||
| Line 251: | Line 260: | ||
| using your real name (no pseudonyms or anonymous contributions.) | using your real name (no pseudonyms or anonymous contributions.) | ||
| - | If you are a package or target maintainer, sometimes you need to slightly modify patches you receive in order to merge them, because the code is not exactly the same in your tree and the submitters' | + | If you are a package or target maintainer, sometimes you need to slightly modify patches you receive in order to merge them, because the code is not exactly the same in your tree and the submitters' |
| <code bash> | <code bash> | ||
| Line 278: | Line 287: | ||
| ==== 11. When to use " | ==== 11. When to use " | ||
| - | The Signed-off-by: | + | The Signed-off-by: |
| If a person was not directly involved in the preparation or handling of a patch but wishes to signify and record their approval of it then they can arrange to have an Acked-by: line added to the patch' | If a person was not directly involved in the preparation or handling of a patch but wishes to signify and record their approval of it then they can arrange to have an Acked-by: line added to the patch' | ||