Re: [git pull v2] documentation: fix almost duplicate filenames (io/IO-mapping.txt)

From: Linus Torvalds
Date: Tue Jul 20 2010 - 12:04:07 EST


On Tue, Jul 20, 2010 at 8:39 AM, Randy Dunlap <randy.dunlap@xxxxxxxxxx> wrote:
>
>    Subject: documentation: fix almost duplicate filenames (IO/io-mapping.txt)
>    From: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

This is still wrong.

The commit message should not have email headers, and it shouldn't
have a From: in it. The authorship (and committer) information is
separate to the message, so the message _should_ look just something
like:

documentation: fix almost duplicate filenames (IO/io-mapping.txt)

   Having both IO-mapping.txt and io-mapping.txt in Documentation/
   was confusing and/or bothersome to some people, so rename
   IO-mapping.txt to bus-virt-phys-mapping.txt.  Also update
   Documentation/00-INDEX for both of these files.

   Signed-off-by: Randy Dunlap <randy.dunlap@xxxxxxxxxx>

and nothing else.

Try using "gitk" on your tree, you'll see how it looks. The first line
is always used as a summary of the whole thing, which is why you want
a single line that describes the thing, and then an empty line,
followed by the more complete description.

The "From: " and "Subject: " lines are just for _emails_ - various git
tools will take an email, and use that email to fill in the commit
information correctly (ie the "Subject:" line of an email becomes that
first summary line, and the "From:" line becomes authorship). But when
you edit the messages directly, don't use those things.

(If you want to set author information that isn't yourself, you'd use
'git commit --author="xyz <xyz@xxxxxxxxxxx>"' etc, but normally you'd
never need that, since normally if you do "git commit" you're
obviously committing your own work).

Linus

Linus
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/