Re: [PATCH] ata-piix: kerneldoc-error-on-ata_piixc.patch 2nd try

[Randy Dunlap <rdunlap@xenotime.net>]

On Mon, 25 Sep 2006 15:39:08 -0400 Jeff Garzik wrote:

> Henne wrote:
> > Heres a new version of the kerneldoc error in ata_piix.c
> > The old one which doesn't apply clean is in 2.6.18-mm1 and can be removed there if acked.
> > 
> > Greets,
> > Henne
> > 
> > From: Henrik Kretzschmar <henne@nachtwindheim.de>
> > 
> > Fixes an error in kerneldoc of ata_piix.c.
> > This is the 2nd try, written for 2.6.18-git4
> > Signed-off-by: Henrik Kretzschmar <henne@nachtwindheim.de>
> 
> Several problems with your patch format:
> 
> 1) your subject line includes-a-bunch-of-words-separated-by-dashes, 
> which is incorrect.  Just use standard English.
> 
> 2) "2nd try" should be inside the brackets ("[", "]"), so that the 
> script removes it during merge
> 
> 3) All comments such as the first paragraph and "Greets, Henne" should 
> be moved underneath the "---" separator, so that they are not copied 
> into the kernel changelog verbatim.  You force people to hand-edit your 
> email before merging.
> 
> 4) No need for "From:" in the email body, it duplicates the email's 
> RFC822 From header.

I agree with all of these except #4.  Maybe you can reconcile your
preference with that in Documentation/SubmittingPatches, which
contains:

<quote>
The canonical patch message body contains the following:

  - A "from" line specifying the patch author.
</quote>

A patch submitter should not need to know the patch receiver's
personal preferences and vary patches based on those.


> 5) Another comment "This is the 2nd try, written for 2.6.18-git4" which 
> should be moved after the "---" separator.  Otherwise, it must be 
> hand-edited out.


---
~Randy