* Commit message header line
@ 2014-05-02 14:38 Eli Zaretskii
2014-05-02 16:06 ` Stephen Berman
0 siblings, 1 reply; 3+ messages in thread
From: Eli Zaretskii @ 2014-05-02 14:38 UTC (permalink / raw)
To: Stephen Berman; +Cc: emacs-devel
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.
TIA
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: Commit message header line
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
0 siblings, 1 reply; 3+ messages in thread
From: Stephen Berman @ 2014-05-02 16:06 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: emacs-devel
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? 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. 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?
Steve Berman
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: Commit message header line
2014-05-02 16:06 ` Stephen Berman
@ 2014-05-02 16:21 ` Eli Zaretskii
0 siblings, 0 replies; 3+ messages in thread
From: Eli Zaretskii @ 2014-05-02 16:21 UTC (permalink / raw)
To: Stephen Berman; +Cc: emacs-devel
> 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.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2014-05-02 16:21 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.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).