]> git.cworth.org Git - notmuch-wiki/blobdiff - patchformatting.mdwn
Tip how to use 'my-notmuch.el'...
[notmuch-wiki] / patchformatting.mdwn
index a61c41aca24d67deee34e6732a887e6124856b39..6ff103a2421df3010240c1d492024c66cb884fcc 100644 (file)
@@ -37,12 +37,13 @@ that is good guideline to follow here too.
 
 Every patch should (must!) contain only one bugfix or new feature.
 
-Eric S. Raymond has written good 'Software Release Practice HOWTO'.
+Eric S. Raymond has written good 
+[Software Release Practice HOWTO](http://tldp.org/HOWTO/Software-Release-Practice-HOWTO/).
 Check what he has to say about this issue. 
 
 ## Prepare patches for e-mail submission
 
-If you're made just one commit (containing just one bugfix or new feature)
+If you've made just one commit (containing just one bugfix or new feature)
 you can run
 
       git format-patch HEAD^
@@ -71,14 +72,18 @@ If you have committed more patches, and want to prepare all of those
 you can check with `git log` a 40-char commit-sha1 of the last commit
 *since* you want to generate patch files. When you enter 
 
-      git format patch commit-sha1(-prefix)
+      git format-patch <commit-sha1(-prefix)>
 
 every commit *after* that commit-sha1 will be used to generate 
 patch files...
 
-## Using git send-email to send patches.
+## Sending patches
 
-If you try to execute `git send-email` and you'll get
+### Using git send-email
+
+(This is the preferred way)
+
+If you try to execute `git send-email` and you get
 
       git: 'send-email' is not a git command. See 'git --help'.
 
@@ -112,16 +117,16 @@ to your own email address to see how the messages appear in your mailbox.
 In this phase you can "streamline" your `git send-email` options for
 actual patch sending to the mailing list.
 
-## Sending one patch using compatible (emacs) email client.
+### Sending one patch using compatible (emacs) email client.
 
 One alternative way to send your patches is to use, for example, the
-emacs mail client you've already used to send mails to notmuch mailing list.
+emacs mail client you've already used to send mails to mailing list.
 In this case you have to be very careful to keep the patch contents
 unchanged:
 
 1. Start composing new mail
 
-2. Enter notmuch mailing list address to To: field.
+2. Enter notmuch mailing list address into To: field.
 
 3. Go to the body part of the email