Re: [PATCH 1/5] Documentation: describe the format of messages with inline patches

From: Drew Northup <drew.northup@maine.edu>
Date: Apr 15, 2011, 20:11 UTC
Message-ID: <1302898291.5926.9.camel@drew-northup.unet.maine.edu>
In-Reply-To: <20110415022202.GB19829@elie>

On Thu, 2011-04-14 at 21:22 -0500, Jonathan Nieder wrote:

Show 6 quoted lines

> Add a DISCUSSION section to the "git format-patch" manual to encourage
> people to send patches in a form that can be applied by "git am"
> automatically.  There are two such forms:
> 
>  1. The default form in which most metadata goes in the mail header
>     and the message body starts with the patch description;

...

> +DISCUSSION
> +----------
> +
> +The patch produced by 'git format-patch' is in UNIX mailbox format,

...

> +
> +arch/arm config files were slimmed down using a python script

...

Show 6 quoted lines

> +Typically it will be placed in a MUA's drafts folder, edited to add
> +timely commentary that should not go in the changelog after the three
> +dashes, and then sent as a message whose body starts with "arch/arm
> +config files were".  On the receiving end, readers can save
> +interesting patches in a UNIX mailbox and apply them with
> +linkgit:git-am[1].

Maybe I'm too picky, but I'd feel more comfortable saying:

... dashes, and then sent as a message which in our example stars with "arch/arm config files were..." On the receiving end, readers can save ...

-- 
-Drew Northup
________________________________________________
"As opposed to vegetable or mineral error?"
-John Pescatore, SANS NewsBites Vol. 12 Num. 59