Re: Making a patch: "git format-patch" does not produce the documented format
From: Dale R. Worley <hidden>
Date: 2016-06-15 22:58:18
From: John Keeping <redacted>
git-format-patch(1) says:
By default, the subject of a single patch is "[PATCH] " followed
by the concatenation of lines from the commit message up to the
first blank line (see the DISCUSSION section of git-commit(1)).
I think that accurately describes what you're seeing. The referenced
DISCUSSION section describes how to write a commit message that is
formatted in a suitable way, with a short first subject line and then a
blank line before the body of the message.
Thanks for the confirmation. I've figured out what is going wrong:
Documentation/SubmittingPatches says:
The first line of the commit message should be a short description (50
characters is the soft limit, see DISCUSSION in git-commit(1)), and
should skip the full stop.
What it *doesn't* say is that the second line of the commit message
should be empty -- precisely so that git format-patch turns the first
line into the Subject: but does not merge the remainder of the commit
message (the "body") into the Subject: line. Now that I know to look
for this, I can see that the commit messages in the Git repository
show this pattern.
I'm preparing some clarifications of SubmittingPatches to explain
things that a new person (e.g., me) would not know. To fix this
issue, I am inserting:
This first line should be a separate paragraph, that is, it should be
followed by an empty line, which is then followed by the body of the
commit message.
Dale