Jonathan Nieder <jrnieder@xxxxxxxxx> writes:
> The hints at [1] might also be useful, in case you would like to try
> and consider improving the manpage to document them if they work.
Don't you need similar updates to sections for other MUAs and procedures?
I suspect that the reason why you added the new text there is because you
know KMail users are very lazy bunch, and once they see a "KMail"
subsection, they will skip everything outside the subsection. Thunderbird
users would also be lazy---after choosing one of the three approaches
presented, they will skip anything outside the subsubsection. So I can
understand that we would need something in these individual subsections,
but the advice does not logically belong there.
Perhaps rephrasing the early part of the Discussion section, with an
illustration that is designed to be more visible, would be a better
approach?
For example, we could take your log message and stuff it there:
The opening "From " line and following lines in "git format-patch" are
for your mailer and should be omitted except for fields that differ from
the mail header when reading your patch into an email body. For example,
the output of your format-patch may begin like this:
From 13c41b41b832d41680ccd33a2422ef8217965566 Mon Sep 17 00:00:00 2001
From: Jonathan Nieder <jrnieder@xxxxxxxxx>
Date: Fri, 13 Jan 2012 17:22:41 -0600
Subject: Documentation/format-patch: mention removal of in-body headers
The opening "From " line and following lines in ...
The part you should send in the body of your e-mail message begins at the
first blank line. The "From $SHA1 $magic_timestamp" line and other header
lines are there to make it look like a mbox, and if you send it in e-mail,
they will become redundant.
You can leave "From:" and/or "Subject:" lines in, if they are
different from the e-mail you will be sending out (e.g. you are
forwarding a patch written by somebody else, as a follow up to an
ongoing discussion and do not want the subject of your e-mail message
to help threading). E.g. your message _may_ begin like this:
From: Jonathan Nieder <jrnieder@xxxxxxxxx>
Subject: Documentation/format-patch: mention removal of in-body headers
The opening "From " line and following lines in ...
when you are not Jonathan, and you are sending it as a response to
an existing discussion thread.
Or something like that?
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html