* Commit netiquette.
@ 2010-02-17 23:44 Óscar Fuentes
2010-02-18 0:27 ` Glenn Morris
` (2 more replies)
0 siblings, 3 replies; 34+ messages in thread
From: Óscar Fuentes @ 2010-02-17 23:44 UTC (permalink / raw)
To: emacs-devel
It would be a Good Thing (TM) to explicitly set good practices for
commits. People is accustomed to CVS and following those customs with
changeset-based systems like Bazaar is counterproductive. VC history,
like code, is written once but read a thousand times, so it is worth to
write it with some care. A correct VC history can be exploited by tools
that traverses it doing useful things (i.e. `bisect').
Let's look at one example:
revno: 99513
committer: Mark A. Hershberger <mah@everybody.org>
branch nick: local
timestamp: Wed 2010-02-17 16:39:21 -0500
message:
2010-02-17 Mark A. Hershberger <mah@everybody.org>
* vc-bzr.el: fix typo in Known Bugs section.
* isearch.el (isearch-update-post-hook): New hook
(isearch-update): Use the new hook.
modified:
lisp/ChangeLog
lisp/isearch.el
lisp/vc-bzr.el
The Committer used the full Changelog entry as the commit message, so on
interfaces that just shows the first line of the commit (like the
emacs-diffs mailing list or the output of `bzr log --short' or `qlog')
you see
2010-02-17 Mark A. Hershberger <mah@everybody.org>
which is hardly indicative of the change.
Ideally, the commit message should be made of a first line indicating
the *purpose* of the change plus a longer text with a more complete
explanation. Usually the changelog entry is good enough as the complete
explanation (without the changelog's entry header!). If the changelog
entry contains only one line and it is descriptive of the purpose of the
change, it can be used as the commit message. In this case, it is
preferable to remove the leading asterisk because it just adds noise and
some text-based tools use asterisks for denoting nodes on the DAG.
Another very important thing is to realize that a changeset-based VCS
presents a view of the progress as a series of atomic steps that changes
the content of the project. This is good because it allows to
unambiguously establish the state of the project at certain point and
identify the steps that caused that state. For this to be really useful,
it is very important to not divide a change among several commits
(i.e. by doing a commit for each edited file) and to not mix different
changes on the same commit, as the case above.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-17 23:44 Commit netiquette Óscar Fuentes
@ 2010-02-18 0:27 ` Glenn Morris
2010-02-18 0:51 ` Óscar Fuentes
2010-02-18 14:45 ` Alfred M. Szmidt
2010-02-18 15:15 ` Mark A. Hershberger
2 siblings, 1 reply; 34+ messages in thread
From: Glenn Morris @ 2010-02-18 0:27 UTC (permalink / raw)
To: Óscar Fuentes; +Cc: emacs-devel
Óscar Fuentes wrote:
> It would be a Good Thing (TM) to explicitly set good practices for
> commits.
Like admin/notes/commits?
But nobody reads admin/notes/.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 0:27 ` Glenn Morris
@ 2010-02-18 0:51 ` Óscar Fuentes
2010-02-18 5:35 ` Glenn Morris
0 siblings, 1 reply; 34+ messages in thread
From: Óscar Fuentes @ 2010-02-18 0:51 UTC (permalink / raw)
To: emacs-devel
Glenn Morris <rgm@gnu.org> writes:
> Óscar Fuentes wrote:
>
>> It would be a Good Thing (TM) to explicitly set good practices for
>> commits.
>
> Like admin/notes/commits?
It's good, although I miss there some statement about not mixing
heterogeneous changes on the same commit.
> But nobody reads admin/notes/.
It is not the most visible place. And how many Emacs hackers watch it
for changes?
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 0:51 ` Óscar Fuentes
@ 2010-02-18 5:35 ` Glenn Morris
2010-02-18 7:13 ` Chong Yidong
0 siblings, 1 reply; 34+ messages in thread
From: Glenn Morris @ 2010-02-18 5:35 UTC (permalink / raw)
To: Óscar Fuentes; +Cc: emacs-devel
Óscar Fuentes wrote:
> And how many Emacs hackers watch it for changes?
No idea. But anyone who doesn't know by now what they are supposed to
do probably either doesn't read emacs-devel, or has tuned out all the
version control discussion, so you might just want to mail Mark and
anyone else who slips up directly, or at least cc them.
(I don't know what isearch-update-post-hook has to do with a feature
freeze either.)
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 5:35 ` Glenn Morris
@ 2010-02-18 7:13 ` Chong Yidong
2010-02-18 15:11 ` Mark A. Hershberger
0 siblings, 1 reply; 34+ messages in thread
From: Chong Yidong @ 2010-02-18 7:13 UTC (permalink / raw)
To: Mark A. Hershberger; +Cc: emacs-devel
Glenn Morris <rgm@gnu.org> writes:
> (I don't know what isearch-update-post-hook has to do with a feature
> freeze either.)
Mark, can you explain the motivation for this change? If not, I am
going to revert it.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 7:13 ` Chong Yidong
@ 2010-02-18 15:11 ` Mark A. Hershberger
0 siblings, 0 replies; 34+ messages in thread
From: Mark A. Hershberger @ 2010-02-18 15:11 UTC (permalink / raw)
To: Chong Yidong; +Cc: emacs-devel
Chong Yidong <cyd@stupidchicken.com> writes:
> Mark, can you explain the motivation for this change? If not, I am
> going to revert it.
I wasn't aware of the freeze. I do scan emacs-devel, but I don't have
time to keep up with every message.
The motivation for the change was to allow the user to modify how the
display is updated after each successive keystroke to isearch.
The specific case that I was looking at using loccur.el
(http://sf.net/projects/loccur) to display only lines that match the
current string. This allows you to easily see all matches in the
current buffer without scrolling around too much.
This specific case seemed to point to hint at other ways the isearch
display could be updated dynamically, so I thought a hook would be
useful.
If causes a problem WRT the freeze, then it should be reverted.
Mark.
--
http://hexmode.com/
The only alternative to Tradition is bad tradition.
— Jaraslov Pelikan
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-17 23:44 Commit netiquette Óscar Fuentes
2010-02-18 0:27 ` Glenn Morris
@ 2010-02-18 14:45 ` Alfred M. Szmidt
2010-02-18 15:12 ` Juanma Barranquero
` (2 more replies)
2010-02-18 15:15 ` Mark A. Hershberger
2 siblings, 3 replies; 34+ messages in thread
From: Alfred M. Szmidt @ 2010-02-18 14:45 UTC (permalink / raw)
To: Óscar Fuentes; +Cc: emacs-devel
revno: 99513
committer: Mark A. Hershberger <mah@everybody.org>
branch nick: local
timestamp: Wed 2010-02-17 16:39:21 -0500
message:
2010-02-17 Mark A. Hershberger <mah@everybody.org>
* vc-bzr.el: fix typo in Known Bugs section.
* isearch.el (isearch-update-post-hook): New hook
(isearch-update): Use the new hook.
modified:
lisp/ChangeLog
lisp/isearch.el
lisp/vc-bzr.el
The Committer used the full Changelog entry as the commit message, so on
interfaces that just shows the first line of the commit (like the
emacs-diffs mailing list or the output of `bzr log --short' or `qlog')
you see
2010-02-17 Mark A. Hershberger <mah@everybody.org>
which is hardly indicative of the change.
This seems more of a short comming in `bzr log --short' than in the
way one writes commit messages. A commit message is more than a
single line. And the purpose of a change is always more suitable in
the actual code as a comment.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 14:45 ` Alfred M. Szmidt
@ 2010-02-18 15:12 ` Juanma Barranquero
2010-02-18 16:14 ` Stefan Monnier
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-18 15:40 ` Óscar Fuentes
2010-02-19 7:53 ` Miles Bader
2 siblings, 2 replies; 34+ messages in thread
From: Juanma Barranquero @ 2010-02-18 15:12 UTC (permalink / raw)
To: ams; +Cc: Óscar Fuentes, emacs-devel
On Thu, Feb 18, 2010 at 15:45, Alfred M. Szmidt <ams@gnu.org> wrote:
> This seems more of a short comming in `bzr log --short' than in the
> way one writes commit messages. A commit message is more than a
> single line. And the purpose of a change is always more suitable in
> the actual code as a comment.
You're conflating quite different things. If I update my tree with
"bzr up", obviously I'm not going to go looking at the code to know
which changes were made, but I certainly will do "bzr log --line -l10"
to see recent changes and their purpose.
And it is ridiculous to say that it is a "shortcoming" of log --short.
--short or --line are a convenience; making sure that the first line
of the commit log summarizes the change is just being nice to fellow
developers. You can always see the full log if you want; is not like
following the recommendation somehow impedes you from writing as long
a commit message as you want.
We currently *have* policies about ChangeLog entries and commit logs,
so I agree with Óscar: it is a good practice and we should require
people to follow it; and treat people who doesn't the same way we
treat people who mangles ChangeLog entries (that is, a gentle but firm
reminder that we have guideliness and we're all expected to follow
them).
Juanma
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 15:12 ` Juanma Barranquero
@ 2010-02-18 16:14 ` Stefan Monnier
2010-02-19 3:42 ` David Reitter
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 8:17 ` Alfred M. Szmidt
1 sibling, 2 replies; 34+ messages in thread
From: Stefan Monnier @ 2010-02-18 16:14 UTC (permalink / raw)
To: Juanma Barranquero; +Cc: Óscar Fuentes, ams, emacs-devel
>> This seems more of a short comming in `bzr log --short' than in the
>> way one writes commit messages.
Not really: it's the whole idea behing "bzr log --short".
> We currently *have* policies about ChangeLog entries and commit logs,
> so I agree with Óscar: it is a good practice and we should require
> people to follow it; and treat people who doesn't the same way we
> treat people who mangles ChangeLog entries (that is, a gentle but firm
> reminder that we have guideliness and we're all expected to follow
> them).
Yes, please, we should require the first line of commit messages to be
an acceptable summary of the whole changeset.
Could someone update log-edit-mode's font-lock patterns so that the
first line is highlighted specially (at least in the Bzr and Arch
cases)?
I think log-edit-mode should even go further in this direction.
The buffer should be created as
----------------
Author:
Summary:
blablabla
----------------
where <blablabla> is the text taken from the ChangeLog. Then for
backends which support the notion of summary-line, C-c C-c could just
signal an error if the Summary line is still blank.
After that, empty header entries will get removed and the text is passed
as-is to the backend who is then free to pass it as-is to the underlying
VCS or to extract the various fields and do whatever it feels like
with them.
Stefan
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 16:14 ` Stefan Monnier
@ 2010-02-19 3:42 ` David Reitter
2010-02-19 5:32 ` Stefan Monnier
2010-02-19 8:17 ` Alfred M. Szmidt
1 sibling, 1 reply; 34+ messages in thread
From: David Reitter @ 2010-02-19 3:42 UTC (permalink / raw)
To: Stefan Monnier; +Cc: emacs-devel@gnu.org discussions
[-- Attachment #1: Type: text/plain, Size: 521 bytes --]
On Feb 18, 2010, at 11:14 AM, Stefan Monnier wrote:
> After that, empty header entries will get removed and the text is passed
> as-is to the backend who is then free to pass it as-is to the underlying
> VCS or to extract the various fields and do whatever it feels like
> with them.
Could one not just add all new commit messages to the appropriate ChangeLogs automatically, maybe once a day?
With the switch to Bzr, the ChangeLog files are the anachronisms, so they could be what's derived from the primary log.
[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 203 bytes --]
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-19 3:42 ` David Reitter
@ 2010-02-19 5:32 ` Stefan Monnier
0 siblings, 0 replies; 34+ messages in thread
From: Stefan Monnier @ 2010-02-19 5:32 UTC (permalink / raw)
To: David Reitter; +Cc: emacs-devel@gnu.org discussions
> Could one not just add all new commit messages to the appropriate
> ChangeLogs automatically, maybe once a day? With the switch to Bzr,
> the ChangeLog files are the anachronisms, so they could be what's
> derived from the primary log.
Please people stop it. We said we'll first switch to Bzr without
changing the ChangeLog policy.
Many people haven't yet figured out how to use Bzr on their system to
access the repository, so clearly it's not yet time to look at the
next step.
Stefan
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 16:14 ` Stefan Monnier
2010-02-19 3:42 ` David Reitter
@ 2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 18:19 ` Stefan Monnier
2010-02-20 11:06 ` Chong Yidong
1 sibling, 2 replies; 34+ messages in thread
From: Alfred M. Szmidt @ 2010-02-19 8:17 UTC (permalink / raw)
To: Stefan Monnier; +Cc: ofv, lekktu, emacs-devel
>> This seems more of a short comming in `bzr log --short' than in the
>> way one writes commit messages.
Not really: it's the whole idea behing "bzr log --short".
bzr log could create a short output in some other fashion, one line is
always often to short to explain a change anyway so this option does
not do much good.
Could someone update log-edit-mode's font-lock patterns so that the
first line is highlighted specially (at least in the Bzr and Arch
cases)?
I think log-edit-mode should even go further in this direction.
The buffer should be created as
----------------
Author:
Summary:
blablabla
----------------
where <blablabla> is the text taken from the ChangeLog. Then for
backends which support the notion of summary-line, C-c C-c could
just signal an error if the Summary line is still blank.
That seems overly forceful, emacs is not just by emacs developers, it
is used by an immense number of people. There have been many changes
done recently that have not been thought through, nor discussed with
those who use emacs. Please stop making such rash decisions; remeber
such changes not only affect you by anyone who uses emacs.
After that, empty header entries will get removed and the text is
passed as-is to the backend who is then free to pass it as-is to
the underlying VCS or to extract the various fields and do whatever
it feels like with them.
This will not help those who use C-c C-a in vc-mode.
A sensible way of attacking the problem would be to have a frob,
log-edit-message-style, this could be set using .dir-locals.el, per
file, or in .emacs. It would affect how C-c C-a behaves, if it
inserts a ChangeLog entry the standard way, or if it also adds an
header.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-19 8:17 ` Alfred M. Szmidt
@ 2010-02-19 18:19 ` Stefan Monnier
2010-02-20 11:02 ` Chong Yidong
2010-02-20 11:06 ` Chong Yidong
1 sibling, 1 reply; 34+ messages in thread
From: Stefan Monnier @ 2010-02-19 18:19 UTC (permalink / raw)
To: ams; +Cc: ofv, lekktu, emacs-devel
> ----------------
> Author:
> Summary:
> blablabla
> ----------------
> where <blablabla> is the text taken from the ChangeLog. Then for
> backends which support the notion of summary-line, C-c C-c could
> just signal an error if the Summary line is still blank.
> That seems overly forceful, emacs is not just by emacs developers, it
> is used by an immense number of people.
I don't see a problem with that. Some people already asks to be able to
commit without having to go through the log-edit step, so the same
config var can be used to decide whether empty commit messages are
accepted (since they currently are, that would most likely be the
default value, which we could modify in the emacs/.dir-locals.el).
BTW, such "enforcement" is useful for a lot more than Emacs's developers.
> After that, empty header entries will get removed and the text is
> passed as-is to the backend who is then free to pass it as-is to
> the underlying VCS or to extract the various fields and do whatever
> it feels like with them.
> This will not help those who use C-c C-a in vc-mode.
I don't see how that interacts. Clearly C-a C-a would bring the text
into the body part of the message. Am I missing something?
Stefan
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-19 18:19 ` Stefan Monnier
@ 2010-02-20 11:02 ` Chong Yidong
0 siblings, 0 replies; 34+ messages in thread
From: Chong Yidong @ 2010-02-20 11:02 UTC (permalink / raw)
To: Stefan Monnier; +Cc: ofv, lekktu, ams, emacs-devel
Stefan Monnier <monnier@IRO.UMontreal.CA> writes:
>> ----------------
>> Author:
>> Summary:
>
>> blablabla
>> ----------------
>>
>> After that, empty header entries will get removed and the text is
>> passed as-is to the backend who is then free to pass it as-is to
>> the underlying VCS or to extract the various fields and do whatever
>> it feels like with them.
>
>> This will not help those who use C-c C-a in vc-mode.
>
> I don't see how that interacts. Clearly C-a C-a would bring the text
> into the body part of the message. Am I missing something?
Also, this kind of behavior works perfectly fine in message-mode, in
commands such as C-c C-y. So there is ample precedent.
(I wonder if it might not be possible to re-use some of the mail-header
code to implement this idea.)
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 18:19 ` Stefan Monnier
@ 2010-02-20 11:06 ` Chong Yidong
2010-02-23 19:25 ` Alfred M. Szmidt
1 sibling, 1 reply; 34+ messages in thread
From: Chong Yidong @ 2010-02-20 11:06 UTC (permalink / raw)
To: ams; +Cc: ofv, lekktu, Stefan Monnier, emacs-devel
"Alfred M. Szmidt" <ams@gnu.org> writes:
> ----------------
> Author:
> Summary:
>
> blablabla
> ----------------
>
> where <blablabla> is the text taken from the ChangeLog. Then for
> backends which support the notion of summary-line, C-c C-c could
> just signal an error if the Summary line is still blank.
>
> That seems overly forceful, emacs is not just by emacs developers, it
> is used by an immense number of people.
I don't think it should issue an error, but it should prompt the user.
This is similar to how message-mode prompts if you mess up the mail
headers, like having a bogus email address in the To: header.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-20 11:06 ` Chong Yidong
@ 2010-02-23 19:25 ` Alfred M. Szmidt
0 siblings, 0 replies; 34+ messages in thread
From: Alfred M. Szmidt @ 2010-02-23 19:25 UTC (permalink / raw)
To: Chong Yidong; +Cc: ofv, lekktu, monnier, emacs-devel
> ----------------
> Author:
> Summary:
>
> blablabla
> ----------------
>
> where <blablabla> is the text taken from the ChangeLog. Then for
> backends which support the notion of summary-line, C-c C-c could
> just signal an error if the Summary line is still blank.
>
> That seems overly forceful, emacs is not just by emacs developers, it
> is used by an immense number of people.
I don't think it should issue an error, but it should prompt the
user. This is similar to how message-mode prompts if you mess up
the mail headers, like having a bogus email address in the To:
header.
I think user interactive promopts should be keep to a minimum. Maybe
one could use font-lock, and just mark it visually.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 15:12 ` Juanma Barranquero
2010-02-18 16:14 ` Stefan Monnier
@ 2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 8:39 ` Juanma Barranquero
1 sibling, 1 reply; 34+ messages in thread
From: Alfred M. Szmidt @ 2010-02-19 8:17 UTC (permalink / raw)
To: Juanma Barranquero; +Cc: ofv, emacs-devel
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain; charset=utf-8, Size: 594 bytes --]
> This seems more of a short comming in `bzr log --short' than in
> the way one writes commit messages. A commit message is more
> than a single line. And the purpose of a change is always more
> suitable in the actual code as a comment.
You're conflating quite different things. If I update my tree with
"bzr up", obviously I'm not going to go looking at the code to know
which changes were made, but I certainly will do "bzr log --line
-l10" to see recent changes and their purpose.
That is the whole idea of a ChangeLog, a short message doesn't
substitute it.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-19 8:17 ` Alfred M. Szmidt
@ 2010-02-19 8:39 ` Juanma Barranquero
2010-02-20 12:37 ` Alfred M. Szmidt
0 siblings, 1 reply; 34+ messages in thread
From: Juanma Barranquero @ 2010-02-19 8:39 UTC (permalink / raw)
To: ams; +Cc: ofv, emacs-devel
> That is the whole idea of a ChangeLog, a short message doesn't
> substitute it.
"bzr log --line" and "C-x C-f ChangeLog <RET>" are different
operations. We're talking about the use of the bzr tool (including
graphical interfaces), not about ChangeLog.
Most people seem to agree that the one-line summary is a nice thing to
have in some contexts. Are you going to go against policy?
Juanma
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-19 8:39 ` Juanma Barranquero
@ 2010-02-20 12:37 ` Alfred M. Szmidt
2010-02-20 14:13 ` Miles Bader
2010-02-20 18:55 ` Juanma Barranquero
0 siblings, 2 replies; 34+ messages in thread
From: Alfred M. Szmidt @ 2010-02-20 12:37 UTC (permalink / raw)
To: Juanma Barranquero; +Cc: ofv, emacs-devel
> That is the whole idea of a ChangeLog, a short message doesn't
> substitute it.
"bzr log --line" and "C-x C-f ChangeLog <RET>" are different
operations. We're talking about the use of the bzr tool (including
graphical interfaces), not about ChangeLog.
The two contain the same information, so essentially they are the
same.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-20 12:37 ` Alfred M. Szmidt
@ 2010-02-20 14:13 ` Miles Bader
2010-02-20 14:23 ` Eli Zaretskii
2010-02-20 18:55 ` Juanma Barranquero
1 sibling, 1 reply; 34+ messages in thread
From: Miles Bader @ 2010-02-20 14:13 UTC (permalink / raw)
To: ams; +Cc: ofv, Juanma Barranquero, emacs-devel
"Alfred M. Szmidt" <ams@gnu.org> writes:
> "bzr log --line" and "C-x C-f ChangeLog <RET>" are different
> operations. We're talking about the use of the bzr tool (including
> graphical interfaces), not about ChangeLog.
>
> The two contain the same information, so essentially they are the
> same.
No.
The short summary represents _extra_ information. It may be derived
from the same original source in many cases, but the editorial decisions
required to construct a summary are non-trivial and useful.
Of course, people could also provide summary lines in a ChangeLog --
e.g., prefix a classic ChangeLog entry with a "SUMMARY:" line. Indeed,
I'd recommend that people do this, even though it's not a part of the
classic ChangeLog format (I do this sometimes when adding a single
cohesive change that touches many files); it makes ChangeLogs easier to
read and more useful.
-Miles
--
80% of success is just showing up. --Woody Allen
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-20 14:13 ` Miles Bader
@ 2010-02-20 14:23 ` Eli Zaretskii
2010-02-22 2:17 ` Miles Bader
2010-02-23 19:25 ` Alfred M. Szmidt
0 siblings, 2 replies; 34+ messages in thread
From: Eli Zaretskii @ 2010-02-20 14:23 UTC (permalink / raw)
To: Miles Bader; +Cc: ofv, lekktu, ams, emacs-devel
> From: Miles Bader <miles@gnu.org>
> Date: Sat, 20 Feb 2010 23:13:31 +0900
> Cc: ofv@wanadoo.es, Juanma Barranquero <lekktu@gmail.com>, emacs-devel@gnu.org
>
> Of course, people could also provide summary lines in a ChangeLog --
> e.g., prefix a classic ChangeLog entry with a "SUMMARY:" line. Indeed,
> I'd recommend that people do this, even though it's not a part of the
> classic ChangeLog format (I do this sometimes when adding a single
> cohesive change that touches many files); it makes ChangeLogs easier to
> read and more useful.
However, the "SUMMARY:" part just wastes precious real estate of the
single line produced by "bzr log --line".
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-20 14:23 ` Eli Zaretskii
@ 2010-02-22 2:17 ` Miles Bader
2010-02-22 4:14 ` Eli Zaretskii
2010-02-23 19:25 ` Alfred M. Szmidt
1 sibling, 1 reply; 34+ messages in thread
From: Miles Bader @ 2010-02-22 2:17 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: ofv, lekktu, ams, emacs-devel
Eli Zaretskii <eliz@gnu.org> writes:
>> Of course, people could also provide summary lines in a ChangeLog --
>> e.g., prefix a classic ChangeLog entry with a "SUMMARY:" line. Indeed,
>> I'd recommend that people do this, even though it's not a part of the
>> classic ChangeLog format (I do this sometimes when adding a single
>> cohesive change that touches many files); it makes ChangeLogs easier to
>> read and more useful.
>
> However, the "SUMMARY:" part just wastes precious real estate of the
> single line produced by "bzr log --line".
Eh? I'm confused... I don't mean they should literally write the string
"SUMMARY:", and I was talking about ChangeLog files, not commit-logs.
What I was advocating was, _in ChangeLog files_, a style like:
2010-02-22 Miles Bader <Miles Bader <miles@gnu.org>>
Frobbed the grot system:
* grot-blah.el (fun1, fun2): Blurged frebly.
* grot-zung.el (fun3): Nug n ug.
* some-grup.el (zoon): Wabawaba.
This isn't always necessary for small/trivial changes, but for longer
ones, i think it's a useful addition.
Indeed, one can imagine a ChangeLog style where the commit-log text
(following typical commit-log conventions) is used a prefix for
traditional ChangeLog-type per-file entries. For instance:
2010-02-22 Miles Bader <Miles Bader <miles@gnu.org>>
Frobbed the grot system
The Grot system was blorked, so rewrite all the zoong-nurbs
using an explicit snood cache.
* grot-blah.el (fun1, fun2): Blurged frebly.
* grot-zung.el (fun3): Nug n ug.
* some-grup.el (zoon): Wabawaba.
Again, all the comments above pertain to ChangeLog files, not
commit-logs [for commit-logs, of course I recommend the standard 1-line
(without period) summary followed if necessary by a more verbose
description in additional paragraphs].
-Miles
--
"... The revolution will be no re-run brothers; The revolution will be live."
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-22 2:17 ` Miles Bader
@ 2010-02-22 4:14 ` Eli Zaretskii
2010-02-23 16:37 ` Stefan Monnier
0 siblings, 1 reply; 34+ messages in thread
From: Eli Zaretskii @ 2010-02-22 4:14 UTC (permalink / raw)
To: Miles Bader; +Cc: ofv, lekktu, ams, emacs-devel
> From: Miles Bader <miles@gnu.org>
> Cc: ofv@wanadoo.es, lekktu@gmail.com, ams@gnu.org, emacs-devel@gnu.org
> Date: Mon, 22 Feb 2010 11:17:23 +0900
>
> > However, the "SUMMARY:" part just wastes precious real estate of the
> > single line produced by "bzr log --line".
>
> Eh? I'm confused... I don't mean they should literally write the string
> "SUMMARY:"
Then it is my misunderstanding, sorry. I thought you did mean
"SUMMARY: bla-bla" literally.
> and I was talking about ChangeLog files, not commit-logs.
Most people simply copy the former into the latter.
> What I was advocating was, _in ChangeLog files_, a style like:
>
> 2010-02-22 Miles Bader <Miles Bader <miles@gnu.org>>
>
> Frobbed the grot system:
> * grot-blah.el (fun1, fun2): Blurged frebly.
> * grot-zung.el (fun3): Nug n ug.
> * some-grup.el (zoon): Wabawaba.
>
> This isn't always necessary for small/trivial changes, but for longer
> ones, i think it's a useful addition.
Right, and I think many, if not most, already do that.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-22 4:14 ` Eli Zaretskii
@ 2010-02-23 16:37 ` Stefan Monnier
0 siblings, 0 replies; 34+ messages in thread
From: Stefan Monnier @ 2010-02-23 16:37 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: ofv, lekktu, ams, emacs-devel, Miles Bader
>> Frobbed the grot system:
>> * grot-blah.el (fun1, fun2): Blurged frebly.
>> * grot-zung.el (fun3): Nug n ug.
>> * some-grup.el (zoon): Wabawaba.
>>
>> This isn't always necessary for small/trivial changes, but for longer
>> ones, i think it's a useful addition.
> Right, and I think many, if not most, already do that.
Not only that: it's recommended. And this recommendation will only grow
stronger over time.
Stefan
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-20 14:23 ` Eli Zaretskii
2010-02-22 2:17 ` Miles Bader
@ 2010-02-23 19:25 ` Alfred M. Szmidt
1 sibling, 0 replies; 34+ messages in thread
From: Alfred M. Szmidt @ 2010-02-23 19:25 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: ofv, lekktu, emacs-devel, miles
> Of course, people could also provide summary lines in a ChangeLog
> -- e.g., prefix a classic ChangeLog entry with a "SUMMARY:" line.
> Indeed, I'd recommend that people do this, even though it's not a
> part of the classic ChangeLog format (I do this sometimes when
> adding a single cohesive change that touches many files); it
> makes ChangeLogs easier to read and more useful.
However, the "SUMMARY:" part just wastes precious real estate of
the single line produced by "bzr log --line".
I think Miles suggestion would strip `SUMMARY:' before putting it into
a log message. Personally, I dislike this kind of behind-the-back
features.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-20 12:37 ` Alfred M. Szmidt
2010-02-20 14:13 ` Miles Bader
@ 2010-02-20 18:55 ` Juanma Barranquero
2010-02-23 19:25 ` Alfred M. Szmidt
1 sibling, 1 reply; 34+ messages in thread
From: Juanma Barranquero @ 2010-02-20 18:55 UTC (permalink / raw)
To: ams; +Cc: ofv, emacs-devel
On Sat, Feb 20, 2010 at 13:37, Alfred M. Szmidt <ams@gnu.org> wrote:
> The two contain the same information, so essentially they are the
> same.
I disagree, and Miles has answered that in detail.
But I find interesting that you didn't answer the main question in my message.
Juanma
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 14:45 ` Alfred M. Szmidt
2010-02-18 15:12 ` Juanma Barranquero
@ 2010-02-18 15:40 ` Óscar Fuentes
2010-02-19 0:22 ` Stephen J. Turnbull
2010-02-19 7:53 ` Miles Bader
2 siblings, 1 reply; 34+ messages in thread
From: Óscar Fuentes @ 2010-02-18 15:40 UTC (permalink / raw)
To: emacs-devel
"Alfred M. Szmidt" <ams@gnu.org> writes:
> The Committer used the full Changelog entry as the commit message, so on
> interfaces that just shows the first line of the commit (like the
> emacs-diffs mailing list or the output of `bzr log --short' or `qlog')
> you see
>
> 2010-02-17 Mark A. Hershberger <mah@everybody.org>
>
> which is hardly indicative of the change.
>
> This seems more of a short comming in `bzr log --short' than in the
> way one writes commit messages. A commit message is more than a
> single line.
This is like saying that "Subject" fields on e-mail messages are of
little use, that one always ought to look at the body of the message
before deciding if it is an interesting one.
> And the purpose of a change is always more suitable in the actual
> code as a comment.
Sure, but describing the purpose on the commit message is useful too,
mostly when the change is not circumscribed to a single point on one
file. Very handy for using with `annotate'.
On this respect I find changelog entries as a lame way of documenting
changes. Most of the time a changelog does not give more information
than what I quickly get combining `log' and `annotate', except when the
changelog entry documents the purpose of the change (not only *what*
changed) but this rarely happens. On projects that extensively use the
commit messages for documenting changes, using `log' and `annotate' is a
great learning tool when you are getting familiar with the code base.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 15:40 ` Óscar Fuentes
@ 2010-02-19 0:22 ` Stephen J. Turnbull
0 siblings, 0 replies; 34+ messages in thread
From: Stephen J. Turnbull @ 2010-02-19 0:22 UTC (permalink / raw)
To: Óscar Fuentes; +Cc: emacs-devel
Óscar Fuentes writes:
> On this respect I find changelog entries as a lame way of documenting
> changes.
Some senior developers are used to this method, and they are already
familiar with the code base. It works well enough, regardless of your
opinion.
The real issues you should be pointing to are (1) accurate commit log
messages are an excellent way to learn about the code base, so the
Emacs infrastructure (edit-log, vc) should try to ensure that commit
logs are as detailed as ChangeLog entries, and (2) ChangeLogs are a
minor but very persistent annoyance (especially to people doing
integrative work, like the maintainers) because they *very* frequently
require special handling, such as merge conflict resolution.
(1) should be easy enough to achieve, but (2) will require balancing
the interests of those used to ChangeLogs with their deficiencies.
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-18 14:45 ` Alfred M. Szmidt
2010-02-18 15:12 ` Juanma Barranquero
2010-02-18 15:40 ` Óscar Fuentes
@ 2010-02-19 7:53 ` Miles Bader
2 siblings, 0 replies; 34+ messages in thread
From: Miles Bader @ 2010-02-19 7:53 UTC (permalink / raw)
To: ams; +Cc: Óscar Fuentes, emacs-devel
"Alfred M. Szmidt" <ams@gnu.org> writes:
> 2010-02-17 Mark A. Hershberger <mah@everybody.org>
>
> which is hardly indicative of the change.
>
> This seems more of a short comming in `bzr log --short' than in the
> way one writes commit messages. A commit message is more than a
> single line.
It's also more or less a universal convention among all modern
source-control systems, so it would be pretty silly to ignore it...
-Miles
--
Run away! Run away!
^ permalink raw reply [flat|nested] 34+ messages in thread
* Re: Commit netiquette.
2010-02-17 23:44 Commit netiquette Óscar Fuentes
2010-02-18 0:27 ` Glenn Morris
2010-02-18 14:45 ` Alfred M. Szmidt
@ 2010-02-18 15:15 ` Mark A. Hershberger
2 siblings, 0 replies; 34+ messages in thread
From: Mark A. Hershberger @ 2010-02-18 15:15 UTC (permalink / raw)
To: emacs-devel
Óscar Fuentes <ofv@wanadoo.es> writes:
> Let's look at one example:
>
> revno: 99513
> committer: Mark A. Hershberger <mah@everybody.org>
Can I just say how honored I am to serve as an example, twice now, for
everyone?
Hopefully everyone else can learn from my mistakes and avoid them!
Mark.
--
http://hexmode.com/
The only alternative to Tradition is bad tradition.
— Jaraslov Pelikan
^ permalink raw reply [flat|nested] 34+ messages in thread
end of thread, other threads:[~2010-02-23 22:57 UTC | newest]
Thread overview: 34+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2010-02-17 23:44 Commit netiquette Óscar Fuentes
2010-02-18 0:27 ` Glenn Morris
2010-02-18 0:51 ` Óscar Fuentes
2010-02-18 5:35 ` Glenn Morris
2010-02-18 7:13 ` Chong Yidong
2010-02-18 15:11 ` Mark A. Hershberger
2010-02-18 14:45 ` Alfred M. Szmidt
2010-02-18 15:12 ` Juanma Barranquero
2010-02-18 16:14 ` Stefan Monnier
2010-02-19 3:42 ` David Reitter
2010-02-19 5:32 ` Stefan Monnier
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 18:19 ` Stefan Monnier
2010-02-20 11:02 ` Chong Yidong
2010-02-20 11:06 ` Chong Yidong
2010-02-23 19:25 ` Alfred M. Szmidt
2010-02-19 8:17 ` Alfred M. Szmidt
2010-02-19 8:39 ` Juanma Barranquero
2010-02-20 12:37 ` Alfred M. Szmidt
2010-02-20 14:13 ` Miles Bader
2010-02-20 14:23 ` Eli Zaretskii
2010-02-22 2:17 ` Miles Bader
2010-02-22 4:14 ` Eli Zaretskii
2010-02-23 16:37 ` Stefan Monnier
2010-02-23 19:25 ` Alfred M. Szmidt
2010-02-20 18:55 ` Juanma Barranquero
2010-02-23 19:25 ` Alfred M. Szmidt
2010-02-23 20:28 ` Juanma Barranquero
2010-02-23 22:09 ` David Kastrup
2010-02-23 22:57 ` Juanma Barranquero
2010-02-18 15:40 ` Óscar Fuentes
2010-02-19 0:22 ` Stephen J. Turnbull
2010-02-19 7:53 ` Miles Bader
2010-02-18 15:15 ` Mark A. Hershberger
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).