| Both sides previous revision Previous revision | Next revisionBoth sides next revision |
| submitting-patches [2024/04/08 11:10] – [13. The canonical patch format] fix third example subject kanjimonster | submitting-patches [2024/06/17 08:59] – old revision restored (2024/01/03 07:44) svanheule |
|---|
| * 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 or known identity 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]] |
| * GitHub web interface or GUI application for git: you must append the ''Signed-off-by:'' line manually in the commit description | * 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: | * git command-line interface: |
| |
| * **the ''Author'' field must match the ''Signed-off-by:'' line** | * **the ''Author'' field must match the ''Signed-off-by:'' line** |
| * GitHub web interface: you must specify your real name or known identity in the ''Name'' field and the ''Primary email address'' to 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: | * git command-line interface: |
| |
| - Description explains **why** it was changed | - Description explains **why** it was changed |
| - Description makes sense | - Description makes sense |
| - Signoff line includes real name or known identity | - Signoff line includes real name |
| - Signoff line includes real email address | - Signoff line includes real email address |
| - If it's a third-party patch, then preserve Signoff line from the original author | - If it's a third-party patch, then preserve Signoff line from the original author |
| - Sender/Author name and email address matches Signoff line's real name or known identity and email address | - Sender/Author name and email address matches Signoff line's real name and email address |
| |
| ===== DTS checklist ===== | ===== DTS checklist ===== |
| </code> | </code> |
| |
| using a known identity (sorry, no 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 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 : | 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 : |
| Subject: [PATCH] x86 generic: switch to 3.3 | Subject: [PATCH] x86 generic: switch to 3.3 |
| |
| Subject: [PATCH v2 001/207] ar71xx: enable sysupgrade on the WRT160Nl | Subject: [PATCHv2 001/207] ar71xx enable sysupgrade on the WRT160Nl |
| </code> | </code> |
| |