From: Eli Zaretskii <eliz@gnu.org>
To: Paul Eggert <eggert@cs.ucla.edu>
Cc: monnier@iro.umontreal.ca, emacs-devel@gnu.org
Subject: Re: lib/ should have its own ChangeLog
Date: Thu, 10 Feb 2011 05:30:37 -0500 [thread overview]
Message-ID: <E1PnTnJ-0001BE-8k@fencepost.gnu.org> (raw)
In-Reply-To: <4D539595.9080507@cs.ucla.edu> (message from Paul Eggert on Wed, 09 Feb 2011 23:36:53 -0800)
> Date: Wed, 09 Feb 2011 23:36:53 -0800
> From: Paul Eggert <eggert@cs.ucla.edu>
> CC: rgm@gnu.org, monnier@iro.umontreal.ca, emacs-devel@gnu.org
>
> On 02/09/2011 11:04 PM, Eli Zaretskii wrote:
> > detailed
> > descriptions of the changeset are supposed to be part of the commit
> > log messages. ChangeLog entries can just state what was changed;
>
> This seems to imply that ChangeLog entries are short and commit
> logs are long. But in practice the reverse is common, with the detailed
> description is in the ChangeLog, and the commit log being a brief
> summary. I'm used to this tradition and don't see why it should
> (ahem) change.
>
> For example, for the most recent entry in lisp/ChangeLog the
> commit record is short:
>
> * allout.el: Synopsis: Change allout user configuration so auto-activation
> is controlled solely by customization `allout-auto-activation'.
>
> whereas the ChangeLog entry is long:
I didn't mean "short" vs "long", I meant "explanations of the
rationale" vs "just the log of changes". Sorry for being unclear.
> 2011-02-10 Ken Manheimer <ken.manheimer@gmail.com>
This is not a good example of what I meant, because it mixes the
change logs and explanations in both the ChangeLog file and the commit
message. What I meant is this:
2011-02-04 Eli Zaretskii <eliz@gnu.org>
* makefile.w32-in (LISP_H, PROCESS_H): New variables.
Replace all uses of lisp.h with $(LISP_H), and all uses of
process.h with $(PROCESS_H).
($(BLD)/editfns.$(O)): Depend on ../lib/strftime.h.
($(BLD)/print.$(O)): Depend on ../lib/ftoastr.h and ../lib/intprops.h.
This describes specifically what was changed and how, but not why.
revno: 103116
committer: Eli Zaretskii <eliz@gnu.org>
branch nick: trunk
timestamp: Fri 2011-02-04 17:32:34 +0200
message:
Update dependencies in src/makefile.w32-in.
The "message" part says what was the rationale for the changes.
2011-02-07 Paul Eggert <eggert@cs.ucla.edu>
conform to C89 pointer rules
* dired.c (scmp, file_name_completion):
Change types between char * and unsigned char *, to satisfy C89
rules about pointer type compatibility.
This does both. I would have only this in the ChangeLog:
* dired.c (scmp, file_name_completion):
Change types between char * and unsigned char *.
And in the commit log message say this:
Change types between char * and unsigned char *, to satisfy C89
rules about pointer type compatibility.
Anyway, this is a question of style, and I'm not sure others will
agree. But this is my opinion, FWIW. My rationale for doing this is
that the commit logs are the main instrument of forensics, so keeping
the "why's" there gives onbe less place to look into.
next prev parent reply other threads:[~2011-02-10 10:30 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2011-02-09 22:39 lib/ should have its own ChangeLog Glenn Morris
2011-02-09 23:55 ` Paul Eggert
2011-02-10 6:36 ` [Bug-vc-dwim] " Ralf Wildenhues
2011-02-10 7:50 ` Paul Eggert
2011-02-10 2:43 ` Stefan Monnier
2011-02-10 4:00 ` Paul Eggert
2011-02-10 5:41 ` Eli Zaretskii
2011-02-10 4:52 ` Glenn Morris
2011-02-10 6:24 ` Paul Eggert
2011-02-10 7:04 ` Eli Zaretskii
2011-02-10 7:36 ` Paul Eggert
2011-02-10 10:30 ` Eli Zaretskii [this message]
2011-02-10 18:09 ` Stefan Monnier
2011-02-10 18:43 ` Paul Eggert
2011-02-10 19:58 ` Stefan Monnier
2011-02-12 23:44 ` Glenn Morris
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=E1PnTnJ-0001BE-8k@fencepost.gnu.org \
--to=eliz@gnu.org \
--cc=eggert@cs.ucla.edu \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/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.