From: Eli Zaretskii <eliz@gnu.org>
To: Stephen Berman <stephen.berman@gmx.net>
Cc: emacs-devel@gnu.org
Subject: Re: Commit message header line
Date: Fri, 02 May 2014 19:21:22 +0300 [thread overview]
Message-ID: <83fvks1799.fsf@gnu.org> (raw)
In-Reply-To: <874n185fn8.fsf@rosalinde.fritz.box>
> From: Stephen Berman <stephen.berman@gmx.net>
> Cc: emacs-devel@gnu.org
> Date: Fri, 02 May 2014 18:06:35 +0200
>
> On Fri, 02 May 2014 17:38:09 +0300 Eli Zaretskii <eliz@gnu.org> wrote:
>
> > Header lines such as these:
> >
> > Add a warning and a menu.
> >
> > Update, improve exposition, add cross references, fix typos.
> >
> > could be more useful if they included a reference to the feature you
> > are fixing, in this case Todo Mode. Otherwise, the header lines are
> > too generic.
>
> Oh dear, sorry about that. Is it possible to fix that without reverting
> and recommitting?
No.
> I did this via VC, and thought the commit message would include the
> string "calendar/todo-mode.el", since it is in the ChangeLog entry
> copied into the commit log buffer, but I see it is not in the log
> listing.
The ChangeLog entries _are_ in the log message, just not in its first
line:
Update, improve exposition, add cross references, fix typos.
* todo-mode.texi: Update, improve exposition, add cross
references, fix typos.
(Inserting New Items, Editing Item Headers and Text): Rewrite to
document new user interface.
However, "bzr log --line" shows only the first line of the log
message, which doesn't mention todo-mode. I was talking only about
the first (a.k.a. "header") line of the commit message.
> But I notice that other log entries do have such a
> string; were they explicitly added to the Subject: line in the commit
> log buffer, or is that because the Subject: line was left blank so just
> the first line of the ChangeLog entry was used? If so, is that
> acceptable practice, or should the Subject: line always be filled in?
When there's only one line of ChangeLog entry, it is customary
(though not required) to make it the header line.
prev parent reply other threads:[~2014-05-02 16:21 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-05-02 14:38 Commit message header line Eli Zaretskii
2014-05-02 16:06 ` Stephen Berman
2014-05-02 16:21 ` Eli Zaretskii [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83fvks1799.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=stephen.berman@gmx.net \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.