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