Re: Patch formatting

Subject: Re: Patch formatting

Date: Thu, 1 Sep 2011 12:49:51 +0200

To: notmuch@notmuchmail.org

Cc:

From: François Gannaz


Hi

On 2011-09-01, Tomi Ollila <tomi.ollila@iki.fi> wrote:
> Hi
> 
> Please check (now updated)
> 
> http://notmuchmail.org/patchformatting/
> 
> page.
> 
> 
> Anything that can me used to improve the content (even furtner!)
> are greatly appreciated.

A few minor suggestions:

* Insert a link for the text "Software Release Practice HOWTO"
  http://tldp.org/HOWTO/Software-Release-Practice-HOWTO/
* s/If you're made/If you've made/
* s/and you'll get/and you get/
* Also replace:
    git format patch commit-sha1(-prefix)
  by
    git format patch <commit-sha1(-prefix)>
* s/to To: field/into To: field/

I also suggest that you insert at the beginning a simple use case:

    # Please commit clean changes (see details in section "Committing")
    $ git commit
      | One line descr
      |
      | Long descr

    # Check which commits to send
    $ git log

    # Prepare patches after 1f77...
    $ git format patch 1f727c65ed864c4cdbb43456b5c8f130f69a193d

    # Send to mailing list (test)
    $ send-email --dry-run --compose 00*.patch

    # Send to mailing list
    $ send-email --compose 00*.patch

--
François

Thread: