Re: [PATCH] Fix list assignments in ob-ocaml.el

[Bernt Hansen <bernt@norang.ca>]

dybbuk-qPb3x58jdZkAvxtiuMwx3w@public.gmane.org (Erik L. Arneson) writes:

> I'm sorry if this is not the correct format to send patches in, but it's
> my first patch.  Hope it looks good.

Comments like this should not be part of the commit message.  The
subject line (after [PATCH] is taken as the first line of the commit
message and the body of the email up to the --- separator is the body of
the commit message.

If you want to add extra detail for the mailing list which should not be
included in the commit message (like your text above) it should be put
between the --- and the diffstat.

You can find an example of a patch with extra detail which is not part
of the commit message here:

http://permalink.gmane.org/gmane.emacs.orgmode/26832

Text in the email between the --- separator and the diffstat is ignored
by 'git am' and 'git apply' so whomever is applying your patch won't
have to edit it manually to remove it.

git format-patch will create a patch file in the correct format
(assuming you've made your changes and committed them in your local
repository.  If it is a single patch

   git format-patch -1

will create a single file with the patch contents.  You can also use 
git send-email --annotate -1 
assuming you have set up the mailing list details in git.

I have the following in my .git/config for org-mode
,----[ .git/config ]
| [sendemail]
| 	to = emacs-orgmode@gnu.org
`----

so git send-email -1 --annotate creates a patch of the current HEAD
commit and drops me in an editor where I can insert extra details
between the --- separator and the diffstat.

The -1 (dash one) specifies how many commits to create patches for.
-3 would take the last 3 commits and create numbered files (or emails)
for submission to the mailing list.

HTH,
Bernt

PS. I know you said to ignore this patch but I thought I'd provide this
    detail anyway.  It's possible to apply a patch manually with fixups
    if it is in not in the correct format for git but it takes extra
    effort by the maintainer.  If you already have commits for your
    changes in git then creating patches in the correct format is easy.