Changes between Version 2 and Version 3 of DeveloperTips


Ignore:
Timestamp:
02/07/17 13:24:05 (7 years ago)
Author:
Samuli Seppänen
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • DeveloperTips

    v2 v3  
    11= Introduction =
    22
    3 This page contains developer documentation that is useful, but not needed often.
     3This 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
     7Getting 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}}}
     11You can then apply the patch:
     12{{{
     13$ git am <pr-number>.patch
     14}}}
     15Then 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
     22And example below:
     23
     24{{{
     25$ git commit -s --amend
     26Update contrib/pull-resolv-conf/client.up for no DOMAIN
     27
     28When no DOMAIN is received from push/pull, do not add either domain or
     29search to the resolv.conf. Fix typo in comment resolv.con[f]. Only add
     30new line when using domain or search.
     31
     32URL: https://github.com/OpenVPN/openvpn/pull/34
     33Acked-by: Steffan Karger <steffan@karger.me>
     34Signed-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}}}
     43After 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}}}
     47Adjust as necessary if you there is more than one patch.
    448
    549= Bisecting commits to detect introduction of a bug =