unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: Eric Abrahamsen <eric@ericabrahamsen.net>
To: help-gnu-emacs@gnu.org
Subject: magit, changelogs and commit formatting
Date: Fri, 11 Sep 2015 23:38:52 +0800	[thread overview]
Message-ID: <87wpvxq837.fsf@ericabrahamsen.net> (raw)

I know we're supposed to move to automatically-generated changelogs Real
Soon Now, but in the meantime...

I'm having a bit of confusion about the best way to format git patches
for Emacs packages. I've pushed a few almost-but-not-quite patches that
other people have had to fix afterwards (I'm talking about commit
message formatting), and that's embarrassing. What I've done in the past
is start the commit from Magit, then hit "C" in the patch buffer, which
inserts a fairly intelligent log template into the commit message
buffer, and then I work with that.

But of course the ChangeLog is supposed to be part of the commit, which
means these messages have to be created before I even get to the commit
buffer, which so far has meant a lot of manually adding function names
and parentheses and making sure there are two spaces between the date
and my name/address.

Is there a different magic function I'm missing? Can some greybeard
quickly share a workflow? How does everyone else do this?

Any hints appreciated,

Eric




             reply	other threads:[~2015-09-11 15:38 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-09-11 15:38 Eric Abrahamsen [this message]
2015-09-11 15:50 ` magit, changelogs and commit formatting Dmitry Gutov
2015-09-11 16:20   ` Eric Abrahamsen
2015-09-11 16:59   ` Stefan Monnier

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: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87wpvxq837.fsf@ericabrahamsen.net \
    --to=eric@ericabrahamsen.net \
    --cc=help-gnu-emacs@gnu.org \
    /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.
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).