From: worley@alum.mit.edu (Dale R. Worley)
To: John Keeping <john@keeping.me.uk>
Cc: git@vger.kernel.org
Subject: Re: Making a patch: "git format-patch" does not produce the documented format
Date: Fri, 2 Aug 2013 18:11:29 -0400 [thread overview]
Message-ID: <201308022211.r72MBT9G020153@freeze.ariadne.com> (raw)
In-Reply-To: <20130731214818.GP2337@serenity.lan> (john@keeping.me.uk)
> From: John Keeping <john@keeping.me.uk>
>
> 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
next prev parent reply other threads:[~2013-08-02 22:11 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2013-07-31 21:31 Making a patch: "git format-patch" does not produce the documented format Dale R. Worley
2013-07-31 21:48 ` John Keeping
2013-08-02 22:11 ` Dale R. Worley [this message]
2013-08-02 23:28 ` Junio C Hamano
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=201308022211.r72MBT9G020153@freeze.ariadne.com \
--to=worley@alum.mit.edu \
--cc=git@vger.kernel.org \
--cc=john@keeping.me.uk \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).