git.cworth.org Git - notmuch-wiki/blob - patchformatting.mdwn

   1 [[!img notmuch-logo.png alt="Notmuch logo" class="left"]]
   2 # Patch Formatting
   3
   4 ## How to Begin
   5
   6 Before you intend to provide patches outside of your local circle
   7 you should check the following:
   8
   9 1. Run `git log` and examine quite a few commit messages.
  10
  11 2. Read mailing list (archives) and follow the discussions on the patches sent.
  12
  13 3. Get familiar with coding conventions used.
  14
  15 This way you get some insight of the look and feel of the patches sent,
  16 both the way code should be written, how to write commit log messages
  17 and how to participate patch discussions.
  18
  19 ## Committing changes (locally)
  20
  21 After you've been editing your changes under cloned notmuch git repository
  22 first commit your changes... preferably (to you) to a separate branch;
  23 if you forgot to branch before starting you can do it now -- your modified
  24 working tree will follow.
  25
  26 Enter your commit message in following format:
  27
  28       first commit line; one line description, up to 65 chars
  29
  30       After one empty line, a detailed description of your changes
  31       the description most usually spans over multiple lines.
  32
  33 The 65-character (limit) seems to be common among many projects so
  34 that is good guideline to follow here too.
  35
  36 ### Activating default pre-commit hook
  37
  38 Git provides a default pre-commit hook which, when activated, checks
  39 (at least) for whitespace errors (trailing whitespace and space before
  40 tab). It is better to notice this kind of "errors" early than have
  41 patch reviewers to mention about those.
  42
  43 The hook, when activated, is named as .git/hooks/pre-commit and it
  44 has execute permissions set on. By default, when git tree is cloned
  45 your hooks dir may have default, inactive pre-commit hook available
  46 as:
  47
  48 1. .git/hooks/pre-commit  without execute permission set
  49
  50 2. .git/hooks/pre-commit.sample  usually with execute permission set
  51
  52 In case of 2, enter `cp .git/hooks/pre-commit.sample .git/hooks/pre-commit`.
  53 And, now enter `chmod a+x .git/hooks/pre-commit` in case it does not
  54 have execute permission set.
  55
  56 ## Remember: one patch per email
  57
  58 Every patch should (must!) contain only one bugfix or new feature.
  59
  60 Eric S. Raymond has written good
  61 [Software Release Practice HOWTO](http://tldp.org/HOWTO/Software-Release-Practice-HOWTO/).
  62 Check what he has to say about this issue.
  63
  64 ### Test Suite Enhancements
  65
  66 New features as well as bug fixes should typically come with test suite
  67 enhancements.  The test suite changes should be done first (tagged as *expected
  68 to fail*), and the feature implementation or bug fix should come second
  69 (removing the *expected to fail* tag).  This way, the test suite specifies the
  70 behavior you're trying to implement, be it a new feature or a bug fix.  By
  71 defining beforehand exactly what you expect to happen, everyone can confirm
  72 that your patch achieves what it is meant it to.
  73
  74 ## Prepare patches for e-mail submission
  75
  76 If you've made just one commit (containing just one bugfix or new feature)
  77 you can run
  78
  79       git format-patch HEAD^
  80
  81 This outputs something like
  82
  83       0001-one-line-description.patch
  84
  85 This is the file name of your patch with content:
  86
  87       From <-40-character-sha1-hexadecimal-string-> Day Mon DD HH:MM:SS YYYY
  88       From: user.name <user.email>
  89       Date: Day, DD Mon YYYY HH:MM:SS TZOFF
  90       Subject: [PATCH] first commit line; one line description, up to 65 chars
  91
  92       after one empty line, a detailed description of your patch
  93       the description most usually spans over multiple lines.
  94       ---
  95        <diffstat lines>
  96        nn files changed, nn insertions(+) nn deletions(-)
  97
  98       diff --git a/<1st filename> b/<1st filename>
  99       ...
 100
 101 If you have committed more patches, and want to prepare all of those
 102 you can check with `git log` a 40-char commit-sha1 of the last commit
 103 *since* you want to generate patch files. When you enter
 104
 105       git format-patch <commit-sha1(-prefix)>
 106
 107 every commit *after* that commit-sha1 will be used to generate
 108 patch files...
 109
 110 ## Sending patches
 111
 112 ### Using git send-email
 113
 114 (This is the preferred way)
 115
 116 If you try to execute `git send-email` and you get
 117
 118       git: 'send-email' is not a git command. See 'git --help'.
 119
 120 Then you're using git installation where send-email command is distributed
 121 in separate package. In Debian/Ububtu/RedHat/Fedora the package is named
 122 `git-email`. Use the package manager in your distribution to install this
 123 package (or ask administrator to do this if you don't have privileges to do so).
 124
 125 Playing with `git send-email` is pretty safe. By default it will ask questions,
 126 finally whether the email is to be sent or not. In normal cases you may
 127 just need to set smtp server (in case local sendmail is not configured to
 128 work properly). Check through `git-send-email` manual page and play with it.
 129
 130 In case of one-file you might want to use
 131
 132       git send-email --annotate 0001-*
 133
 134 (other options omitted) to add a 'discussion' part into your
 135 email. The `git am` tool which is eventually used to submit the patch
 136 will ignore anything after first `---` and before the `diff --git ...`
 137 in the mail message (see example content above). In this case be careful
 138 you don't break the commit log message or the patch content.
 139
 140 In case of multi-patch send, `git send-email --compose 00*.patch` can be
 141 used to send an introductory message (as separate email). This also follows
 142 the principle of sending only one patch per mail -- by sending each patch
 143 in separate mails.
 144
 145 After you've played (perhaps with `--dry-run`) a bit, send first test emails
 146 to your own email address to see how the messages appear in your mailbox.
 147 In this phase you can "streamline" your `git send-email` options for
 148 actual patch sending to the mailing list.
 149
 150 ### Sending one patch using compatible (emacs) email client.
 151
 152 Sometimes using git-send-email is not possible; It is not installed by
 153 default and you don't have privileges to install it or you are not
 154 able to compile it as it has more build-time requirements as git itself.
 155
 156 One alternative way to send your patches is to use, for example, the
 157 emacs mail client you've already used to send mails to mailing list.
 158 In this case you have to be very careful to keep the patch contents
 159 unchanged:
 160
 161 1. Start composing new mail
 162
 163 2. Enter notmuch mailing list address into To: field.
 164
 165 3. Go to the body part of the email
 166
 167 4. Enter `C-x i` (M-x insert-file) and insert the patch file to the buffer
 168
 169 5. Replace Subject: line from the Subject line of the patch.
 170
 171 6. Remove everything before the description content from the beginning of the body.
 172
 173 7. Fill the discussion part after `---` unless you have done so (and there is anything to discuss).
 174
 175 8. Check your text once more and then enter `C-c C-c` (message-send-and-exit).
 176
 177 When your patches appear on the mailing list read the comments and take part
 178 to the discussion and prepare to do adjustments to your patches.