Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revisionBoth sides next revision
submitting-patches [2019/04/06 02:28] – [13. The canonical patch format] formatting vgaeterasubmitting-patches [2024/06/17 08:59] – old revision restored (2024/01/03 07:44) svanheule
Line 1: Line 1:
 ====== Submitting patches ====== ====== Submitting patches ======
-See also [[docs:guide-developer:faq-development|Development FAQ]] +See also
 +  * [[docs:guide-developer:working-with-git-email|Sending patches by git send-email]] 
 +  * If you are using GitHub, read also [[docs:guide-developer:working-with-github-pr|Working with GitHub]].
  
-If you are using GitHub read also [[docs:guide-developer:working-with-github-pr|Working with GitHub]].+=====Deciding where to send the patch===== 
  
-Patches can be submitted as a pull request on Github or via the mailing list.+  * **Patches to core packages and patches that add support for new devices** (i.e. code that is in [[https://git.openwrt.org/?p=openwrt/openwrt.git;a=summary|the main OpenWrt repository]] ) can be submitted as a pull request on [[https://github.com/openwrt/openwrt|the GitHub mirror]] or via the mailing list. 
 + 
 +  * **Patches for LuCI web interface and related packages** can be submitted to mailing list or to the [[https://github.com/openwrt/luci/| Github mirror]] of the LuCI git repository.  Specific guidelines and hints for contributing to the //LuCI// repo may be found at [[https://github.com/openwrt/luci/blob/master/CONTRIBUTING.md| Contributing Guidelines]]. 
 + 
 +  * **Patches for community packages about routing** should go as a Github PR in the [[https://github.com/openwrt-routing/packages| OpenWrt community routing packages repo]].  Use the //packages// contributing guidelines below when contributing to the //routing// repo. 
 + 
 +  * **Patches for community packages about telephony and SIP/VOIP** should go as a Github PR in the  [[https://github.com/openwrt/telephony| OpenWrt community telephony packages repo]].  Use the //packages// contributing guidelines below when contributing to the //telephony// repo. 
 + 
 +  * **Patches for miscellaneous community packages** should go as a Github PR in the [[https://github.com/openwrt/packages|OpenWrt community package repo]].  Specific guidelines and hints for contributing to the //packages// repo may be found at [[https://github.com/openwrt/packages/blob/master/CONTRIBUTING.md| Contributing Guidelines]]. 
 + 
 +<WRAP round info 60%> 
 +**If you want to add a new package that is not specific for a device** nor crucial to compile or use OpenWrt on a device, (i.e. tools, compilers, runtimes libraries, VPNs, media servers, backup servers and more), **open a PR in the appropriate community packages repository mentioned above.** Note that if you add a package you usually must assign yourself as "maintainer" of it. 
 +</WRAP> 
 +  
 + 
 +===== Submission Guidelines =====
  
 Submissions should follow the following guidelines: Submissions should follow the following guidelines:
-  * use a different git branch for each pull request (GitHub does this automatically if you edit files through the website)+  * use a different git branch for each pull request (GitHub does this automatically when using web interface)
   * write commit subject and message in the imperative form: "add support for X", NOT "added support for X"   * write commit subject and message in the imperative form: "add support for X", NOT "added support for X"
   * **code formatting**   * **code formatting**
Line 30: Line 47:
     * If you add support for new hardware: Include in your commit message a short description of the hardware and how to install OpenWrt on it. Have a look at the [[https://git.openwrt.org/?p=openwrt/openwrt.git&a=search&h=HEAD&st=commit&s=add+support+for|recent additions]] for some examples.     * If you add support for new hardware: Include in your commit message a short description of the hardware and how to install OpenWrt on it. Have a look at the [[https://git.openwrt.org/?p=openwrt/openwrt.git&a=search&h=HEAD&st=commit&s=add+support+for|recent additions]] for some examples.
  
-  * **all commits must contain ''%%Signed-off-by: My Name <my@email.address>%%'' where you write your real name and real email address**, in accordance with [[http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?id=HEAD#n416|Section 11 of the Linux Kernel patches guide]]. +  * **all commits must contain ''%%Signed-off-by: My Name <my@email.address>%%'' where you write your real name and real email address**, in accordance with [[http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst?id=HEAD#n416|Section 11 of the Linux Kernel patches guide]] 
-    * it can be done automatically by git commandline with<code>git commit --signoff</code>+    * GitHub web interface or GUI application for git: you must append the ''Signed-off-by:'' line manually in the commit description 
 +    * git command-line interface:
  
-  * **the Author field must match** the "Signed-off-by:line  +<code bash> 
-    * if you are editing files and committing through GitHubyou must write your real name in the "Namefield in GitHub settings and the email used in the "Signed-off-by:" must be your primary github email +git commit --signoff 
-    * if you are editing files and committing on your local PC, set your name and email with<code>+</code> 
 + 
 +  * **the ''Author'' field must match the ''Signed-off-by:'' line** 
 +    * GitHub web interface: you must specify your real name in the ''Name'' field and the ''Primary email address'' to match the ''Signed-off-by:'' line 
 +    * git command-line interface: 
 + 
 +<code bash>
 git config --global user.name "my name" git config --global user.name "my name"
-git config --global user.email "my@email.address"</code>+git config --global user.email "my@email.address" 
 +</code>
  
 ===== Patch merging and tree life cycle ===== ===== Patch merging and tree life cycle =====
Line 45: 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, private servers, GitHub ...   - Staging trees can be hosted as part of the projects git infrastructure, private servers, GitHub ...
 +===== 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 ''git cherry-pick'' command with the ''-x'' argument and thus append a line that says ''(cherry picked from commit <commit>)'' to the original commit message ([[https://github.com/openwrt/openwrt/commit/59fd8f08cf544a7f0fcaf700ca9af9292de3adcc.patch|example]]) in order to indicate which commit this change was cherry-picked from. This is needed for traceability. It is also required that you add the ''--signoff'' to the commits, if you did not create the original commits. 
 +<code bash> 
 +$ git cherry-pick --signoff -x <commit> 
 +</code>
 ===== Patch checklist ===== ===== Patch checklist =====
   - Single commit ( multiple commits must first be squashed, as described [[docs:guide-developer:working-with-github-pr#squashing_commits|here]]  )   - Single commit ( multiple commits must first be squashed, as described [[docs:guide-developer:working-with-github-pr#squashing_commits|here]]  )
Line 63: Line 95:
   - Remove all ocurrencies of ''default-state = "off"'' properties under your LED nodes ([[https://github.com/openwrt/openwrt/commit/0d23fd2ab29a66f5d03187db4fac3e396b4f3b62|details]])   - Remove all ocurrencies of ''default-state = "off"'' properties under your LED nodes ([[https://github.com/openwrt/openwrt/commit/0d23fd2ab29a66f5d03187db4fac3e396b4f3b62|details]])
   - If you're adding MTD flash layout, and you've ''label = "firmware"'' or a node with the name ''firmware@xyz'', please check that you've added proper ''compatible'' property (if applicable) ([[https://github.com/openwrt/openwrt/pull/1586/commits/22c1d69e63a3e80c41baf3941d5e6deb2019d039|details]])   - If you're adding MTD flash layout, and you've ''label = "firmware"'' or a node with the name ''firmware@xyz'', please check that you've added proper ''compatible'' property (if applicable) ([[https://github.com/openwrt/openwrt/pull/1586/commits/22c1d69e63a3e80c41baf3941d5e6deb2019d039|details]])
-  - If it's possible try to dedicate some of the LEDs for system status indication in [[https://github.com/openwrt/openwrt/blob/master/package/base-files/files/etc/diag.sh|diag.sh]] ([[https://github.com/openwrt/openwrt/blob/master/target/linux/ath79/dts/qca9533_tplink_tl-wr841-v11.dts#L13|example]])+  - If it's possible try to dedicate some of the LEDs for system status indication in [[https://github.com/openwrt/openwrt/blob/master/package/base-files/files/etc/diag.sh|diag.sh]] ([[https://github.com/openwrt/openwrt/blob/master/target/linux/ath79/dts/qca9533_tplink_tl-wr841-v11.dtsi#L7|example]])
   - The name of a node should reflect the function of the device and not its model. Examples for generic node names can be found in Section [[https://github.com/devicetree-org/devicetree-specification/blob/master/source/devicetree-basics.rst#generic-names-recommendation|2.2.2 Generic Names Recommendation]]   - The name of a node should reflect the function of the device and not its model. Examples for generic node names can be found in Section [[https://github.com/devicetree-org/devicetree-specification/blob/master/source/devicetree-basics.rst#generic-names-recommendation|2.2.2 Generic Names Recommendation]]
   - Remove all [[https://github.com/devicetree-org/devicetree-specification/blob/master/source/devicetree-basics.rst#device_type-deprecated|deprecated "device_type"]] properties, unless for "memory" or "cpu" nodes   - Remove all [[https://github.com/devicetree-org/devicetree-specification/blob/master/source/devicetree-basics.rst#device_type-deprecated|deprecated "device_type"]] properties, unless for "memory" or "cpu" nodes
  
 +An overview of non-mandatory guidelines for device support submissions is provided in [[docs:guide-developer:device-support-policies|Device support policies / best practices]]
 ===== In-depth process of preparing and submitting code to OpenWrt ===== ===== In-depth process of preparing and submitting code to OpenWrt =====
 Based on [[https://www.kernel.org/doc/html/latest/process/submitting-patches.html|​Linux Kernel patch submission guidelines]]. Based on [[https://www.kernel.org/doc/html/latest/process/submitting-patches.html|​Linux Kernel patch submission guidelines]].
  
-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." This text is a collection of suggestions which can greatly increase the chances of your change being accepted. 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 text is a collection of suggestions which can greatly increase the chances of your change being accepted.
- 
-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 what problem you are addressing and your proposed solution +  * Explain what problem you are addressing and your proposed solution. 
-    do write useful patches including documentation +  * Write useful patches including documentation. 
-    test test test+  * Test, testtest.
  
 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 [[:start|OpenWrt wiki]] +  * [[:start|OpenWrt wiki]] 
-  * ​Mailing Lists +  * ​[[:contact#mailing_lists|Mailing Lists]] 
-  * Forums like [[https://forum.openwrt.org]] +  * [[:contact#irc_channels|IRC]] 
-  * IRC irc.freenode.net, channels #openwrt and #openwrt-devel +  * [[https://forum.openwrt.org|OpenWrt Forum]] 
-  * TRAC ​​https://dev.openwrt.org/ the issue/bug/change tracking system. (TRAC is closed now, and only kept for archiving purposes.) +  * GitHub - ​https://github.com/openwrt/openwrt - trunk development and bugtracking 
-  * Github - ​http://github.com/openwrt - trunk development, and bugtracking has been moved here.+  * (archived) TRAC ​​https://dev.openwrt.org/ the issue/bug/change tracking system. (TRAC is closed now, and only kept for archiving purposes.)
  
 ===== Documentation ===== ===== Documentation =====
 It is often best to document what you are doing before you do it. The process of documentation often exposes possible improvements. Keep your documentation up to date. It is often best to document what you are doing before you do it. The process of documentation often exposes possible improvements. Keep your documentation up to date.
  
-===== Creating and Sending your change =====+===== Creating and sending your change =====
 Read [[:submitting-patches#patch_checklist|Submit Checklist]] for a list of items to check before submitting code. Read [[:submitting-patches#patch_checklist|Submit Checklist]] for a list of items to check before submitting code.
  
-For patches against external package sources, refer to the quilt howto at [[docs:guide-developer:build-system:use-patches-with-buildsystem]]+For patches against external package sources, refer to the quilt howto at [[docs:guide-developer:toolchain:use-patches-with-buildsystem]]
  
 Please read ​[[https://www.kernel.org/doc/html/v4.11/process/email-clients.html|Email clients for patches]] to find out how to make sure your email client doesn't destroy your patch. Please read ​[[https://www.kernel.org/doc/html/v4.11/process/email-clients.html|Email clients for patches]] to find out how to make sure your email client doesn't destroy your patch.
Line 106: Line 137:
 Patches should be based in the root trunk, not in any lower subdirectory. Patches should be based in the root trunk, not in any lower subdirectory.
  
-Make sure your patch does not include any extra files which do not belong in a patch submission. Make sure to review your patch -afteryou have generated it, to ensure accuracy.+Make sure your patch does not include any extra files which do not belong in a patch submission. 
 +Be sure to review your patch **after** you have generated it, to ensure accuracy.
  
-If your changes produce a lot of deltas, you may want to look into splitting them into individual patches which modify things in logical stages. This will facilitate easier reviewing by other OpenWrt developers, which is very important if you want your patch to be accepted.+If your changes produce a lot of deltas, you may want to look into splitting them into individual patches which modify things in logical stages. 
 +This will facilitate easier reviewing by other OpenWrt developers, which is very important if you want your patch to be accepted.
  
 The tools you can use to create a patch, in order of preference, are: The tools you can use to create a patch, in order of preference, are:
Line 115: 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'll be commented upon, and committed into trunk at some point.+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'll be commented upon, and committed into trunk at some point.
  
 ==== 2. Describe your changes ===== ==== 2. Describe your changes =====
Line 145: Line 179:
  
 ==== 5. Select email destination ===== ==== 5. Select email destination =====
-Look in the Makefile if a MAINTAINER macro exists. If so, e-mail that person. Unless you have a reason NOT to do so, always CC openwrt-devel <at> lists.openwrt.org. If no maintainer is listed, send your patch to the [[https://lists.openwrt.org/mailman/listinfo/openwrt-devel|​primary OpenWrt developer's mailing list]]. Most OpenWrt developers monitor this e-mail list, and can comment on your changes.+Look in the Makefile if a MAINTAINER macro exists. If so, email that person. Unless you have a reason NOT to do so, always CC openwrt-devel <at> lists.openwrt.org. If no maintainer is listed, send your patch to the [[https://lists.openwrt.org/mailman/listinfo/openwrt-devel|​primary OpenWrt developer's mailing list]]. Most OpenWrt developers monitor this email list, and can comment on your changes.
  
 ==== 6. No MIME, no links, no compression, no attachments, just plain text ===== ==== 6. No MIME, no links, no compression, no attachments, just plain text =====
-OpenWrt developers need to be able to read and comment on the changes you are submitting. It is important for an OpenWrt developer to be able to "quote" your changes, using standard e-mail tools, so that they may comment on specific portions of your code.+OpenWrt developers need to be able to read and comment on the changes you are submitting. It is important for an OpenWrt developer to be able to "quote" your changes, using standard email tools, so that they may comment on specific portions of your code.
  
-For this reason, all patches should be submitting e-mail "inline". WARNING: Be wary of your editor's word-wrap corrupting your patch, if you choose to cut-n-paste your patch.+For this reason, all patches should be submitting email "inline". WARNING: Be wary of your editor's word-wrap corrupting your patch, if you choose to cut-n-paste your patch.
  
-Do not attach the patch as a MIME attachment, compressed or not. Many popular e-mail applications will not always transmit a MIME attachment as plain text, making it impossible to comment on your code.+Do not attach the patch as a MIME attachment, compressed or not. Many popular email applications will not always transmit a MIME attachment as plain text, making it impossible to comment on your code.
  
 Exception: If your mailer is mangling patches then someone may ask you to re-send them using MIME. Exception: If your mailer is mangling patches then someone may ask you to re-send them using MIME.
  
 Mozilla Thunderbird requires that you change email defaults to send plain text email. Mozilla Thunderbird requires that you change email defaults to send plain text email.
-read [[http://kb.mozillazine.org/Plain_text_e-mail_%28Thunderbird%29|Plain text e-mail - Thunderbird]]+read [[http://kb.mozillazine.org/Plain_text_e-mail_%28Thunderbird%29|Plain text email - Thunderbird]]
 :!: disable flowed text :!: disable flowed text
  
Line 163: Line 197:
 Large changes are not appropriate for mailing lists, and some maintainers. If your patch, uncompressed, exceeds 300 kB in size, it is preferred that you store your patch on an Internet-accessible server, and provide instead a URL (link) pointing to your patch. Large changes are not appropriate for mailing lists, and some maintainers. If your patch, uncompressed, exceeds 300 kB in size, it is preferred that you store your patch on an Internet-accessible server, and provide instead a URL (link) pointing to your patch.
  
-==== 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, so finding problems early is a good thing.  
 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 172: Line 209:
    * Your patch was not sufficiently discussed on openwrt-devel.    * Your patch was not sufficiently discussed on openwrt-devel.
    * A style issue.    * A style issue.
-   * An e-mail formatting issue (re-read this section).+   * An email formatting issue (re-read this section).
    * A technical problem with your change.    * A technical problem with your change.
-   * They get tons of e-mail, and yours got lost in the shuffle.+   * They get tons of email, and yours got lost in the shuffle.
    * You are being annoying.    * You are being annoying.
  
Line 180: Line 217:
  
 ==== 9. Include PATCH in the subject ===== ==== 9. Include PATCH in the subject =====
-Due to high e-mail traffic to openwrt-devel, it is common convention to prefix your subject line with [PATCH]. This lets OpenWrt developers more easily distinguish patches from other e-mail discussions, and will also make its way to the patchwork automatically.+Due to high email traffic to openwrt-devel, it is common convention to prefix your subject line with [PATCH]. This lets OpenWrt developers more easily distinguish patches from other email discussions, and will also make its way to the patchwork automatically.
  
 ==== 10. Sign your work ===== ==== 10. Sign your work =====
Line 217: Line 254:
 then you just add a line saying then you just add a line saying
  
-<code>+<code bash>
 Signed-off-by: Random J Developer <random@developer.example.org> Signed-off-by: Random J Developer <random@developer.example.org>
 </code> </code>
Line 223: 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 stick strictly to rule (c), you should ask the submitter to rediff, but this is a totally counter-productive waste of time and energy. Rule (b) allows you to adjust the code, but then it is very impolite to change one submitter's code and make him endorse your bugs. To solve this problem, it is recommended that you add a line between the last Signed-off-by header and yours, indicating the nature of your changes. While there is nothing mandatory about this, it seems like prepending the description with your mail and/or name, all enclosed in square brackets, is noticeable enough to make it obvious that you are responsible for last-minute changes. Example :+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 stick strictly to rule (c), you should ask the submitter to rediff, but this is a totally counter-productive waste of time and energy. Rule (b) allows you to adjust the code, but then it is very impolite to change one submitter's code and make them endorse your bugs. To solve this problem, it is recommended that you add a line between the last Signed-off-by header and yours, indicating the nature of your changes. While there is nothing mandatory about this, it seems like prepending the description with your mail and/or name, all enclosed in square brackets, is noticeable enough to make it obvious that you are responsible for last-minute changes. Example :
  
-<code>+<code bash>
 Signed-off-by: Random J Developer <random@developer.example.org> Signed-off-by: Random J Developer <random@developer.example.org>
 [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h] [lucky@maintainer.example.org: struct foo moved from foo.c to foo.h]
Line 235: Line 272:
 Special note to back-porters: It seems to be a common and useful practise to insert an indication of the origin of a patch at the top of the commit message (just after the subject line) to facilitate tracking. For instance: Special note to back-porters: It seems to be a common and useful practise to insert an indication of the origin of a patch at the top of the commit message (just after the subject line) to facilitate tracking. For instance:
  
-<code>+<code bash>
 Date:   Wed Jul 25 15:14:50 2012 +0300 Date:   Wed Jul 25 15:14:50 2012 +0300
     [generic] add missing symbols     [generic] add missing symbols
Line 244: Line 281:
  
 For the more convenient developers, git can automatically add a sign-off: For the more convenient developers, git can automatically add a sign-off:
-<code>git commit -s</code>+ 
 +<code bash> 
 +git commit -s 
 +</code>
  
 ==== 11. When to use "Acked-by:" and "Cc:" ===== ==== 11. When to use "Acked-by:" and "Cc:" =====
-The Signed-off-by: tag indicates that the signer was involved in the development of the patch, or that he/she was in the patch's delivery path.+The Signed-off-by: tag indicates that the signer was involved in the development of the patch, or that they were in the patch's delivery path.
  
 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's changelog. 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's changelog.
Line 295: Line 335:
 The canonical patch subject line is: The canonical patch subject line is:
  
-<code>+<code bash>
 Subject: [PATCH 001/123] [section] summary phrase Subject: [PATCH 001/123] [section] summary phrase
 </code> </code>
Line 324: Line 364:
 Some example Subjects: Some example Subjects:
  
-<code>+<code bash>
 Subject: [PATCH] e2fsprogs: Bump to 1.41.3 Subject: [PATCH] e2fsprogs: Bump to 1.41.3
  
Line 334: Line 374:
 The "from" line must be the very first line in the message body, and has the form: The "from" line must be the very first line in the message body, and has the form:
  
-<code>+<code bash>
 From: Original Author <author@example.com> From: Original Author <author@example.com>
 </code> </code>
  • Last modified: 2024/12/06 16:55
  • by wertwert4pda