3 | | This page contains developer documentation that is useful, but not needed often. |
| 3 | This page contains developer documentation that is useful, but not needed very often. |
| 4 | |
| 5 | = Sending !GitHub pull requests to the mailing list with git-send-email = |
| 6 | |
| 7 | Getting a "git am"-compatible patch out of a !GitHub pull requests is simple: |
| 8 | {{{ |
| 9 | $ wget https://github.com/OpenVPN/openvpn/pull/<pr-number>.patch |
| 10 | }}} |
| 11 | You can then apply the patch: |
| 12 | {{{ |
| 13 | $ git am <pr-number>.patch |
| 14 | }}} |
| 15 | Then you should amend the commit message to add information and to fix errors (if any): |
| 16 | |
| 17 | * What pull request the patch was created from |
| 18 | * Who ACKed the patch |
| 19 | * Who relayed the patch (in case if you're not the author) |
| 20 | * Fix formatting issues |
| 21 | |
| 22 | And example below: |
| 23 | |
| 24 | {{{ |
| 25 | $ git commit -s --amend |
| 26 | Update contrib/pull-resolv-conf/client.up for no DOMAIN |
| 27 | |
| 28 | When no DOMAIN is received from push/pull, do not add either domain or |
| 29 | search to the resolv.conf. Fix typo in comment resolv.con[f]. Only add |
| 30 | new line when using domain or search. |
| 31 | |
| 32 | URL: https://github.com/OpenVPN/openvpn/pull/34 |
| 33 | Acked-by: Steffan Karger <steffan@karger.me> |
| 34 | Signed-off-by: Samuli Seppänen <samuli@openvpn.net> |
| 35 | |
| 36 | # Please enter the commit message for your changes. Lines starting |
| 37 | # with '#' will be ignored, and an empty message aborts the commit. |
| 38 | # |
| 39 | # Author: Jeffrey Cutter <jeff_m_cutter@yahoo.com> |
| 40 | # Date: Sat Sep 12 20:03:18 2015 -0400 |
| 41 | ... |
| 42 | }}} |
| 43 | After adjusting the commit message you can send the patch using git-send-email: |
| 44 | {{{ |
| 45 | $ git-send-email --to=openvpn-devel@lists.sourceforge.net HEAD^1...HEAD |
| 46 | }}} |
| 47 | Adjust as necessary if you there is more than one patch. |