From: Juanma Barranquero <lekktu@gmail.com>
To: Glenn Morris <rgm@gnu.org>
Cc: Emacs developers <emacs-devel@gnu.org>
Subject: Re: [Emacs-diffs] trunk r116644: ChangeLog entries should be usable without the VCS
Date: Tue, 4 Mar 2014 19:05:14 +0100 [thread overview]
Message-ID: <CAAeL0STgxsDXV4YvxBWsvB=r608XsH1uALNFedfmEmw-qyCkMw@mail.gmail.com> (raw)
In-Reply-To: <p2vbvt50w1.fsf@fencepost.gnu.org>
On Tue, Mar 4, 2014 at 6:28 PM, Glenn Morris <rgm@gnu.org> wrote:
> The ChangeLog should be understandable to someone sitting there with
> just the source tarball and no VCS.
As previously stated, I disagree because I don't think these people
are the real target. The ChangeLogs already do not match that
description. Some entries, particularly the more recent ones, if
unusually well written, *might* approach that goal, but most won't,
not without looking at the corresponding changesets. I know that for a
fact: I often look at the ChangeLog entry, then to the annotate
listing, and then to the diff to really see what was going on.
Our ChangeLogs, much as I like them and don't want to see them go, are
in that nebulous place between being a list of changes for outside
people (not really, too verbose and rambling*, that's what NEWS is for
and does a much better job), and a complete list of changes for the
source code tinkerer and developer (it isn't near complete enough, for
serious work you need the repo). So the goal that our ChangeLogs
satisfy right now is as a helpful tool to speed locating relevant
changes, or as a (incomplete) reminder of when was something done, and
by whom.
(*Like many of my posts ;-)
If you think that I'm exaggerating and our ChangeLogs are really
pretty complete, I posit that, as an example, while "Follow-up to
revno:XXXX" doesn't say much, "Fix last change." doesn't really say
much more (yes, you can locate the change it refers to, but, how was
it fixed, and what was the problem that required such fixing?). And
there are literally hundreds of such entries in our ChangeLogs.
> Git hashes versus bzr
> revisions, generated ChangeLogs, what gets written in *commit* logs, the
> various ways people access the Emacs sources, it's all irrelevant.
No, I don't think so.
> Anyway, none of this gets us any closer to 24.4.
> So I hope this thread will die, and that people with the time to comment
> will instead look at documenting the remaining issues in NEWS and fixing
> the numerous outstanding bugs.
Writing docs, no thanks. Unable to. As for the rest, my feature-freeze
patches are all bug fixes or typo fixes (which are bugs IMO); so I
tend to agree.
J
next prev parent reply other threads:[~2014-03-04 18:05 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <E1WKWHG-000385-BB@vcs.savannah.gnu.org>
2014-03-03 17:09 ` [Emacs-diffs] trunk r116644: ChangeLog entries should be usable without the VCS Juanma Barranquero
2014-03-03 17:31 ` David Kastrup
2014-03-03 18:06 ` Juanma Barranquero
2014-03-03 18:09 ` Alan Mackenzie
2014-03-03 18:19 ` Juanma Barranquero
2014-03-03 19:22 ` Dmitry Gutov
2014-03-03 21:23 ` Andreas Schwab
2014-03-03 22:00 ` Alan Mackenzie
2014-03-03 22:28 ` Andreas Schwab
2014-03-03 22:35 ` Alan Mackenzie
2014-03-03 22:53 ` Andreas Schwab
2014-03-04 8:26 ` Stephen J. Turnbull
2014-03-04 16:35 ` Eli Zaretskii
2014-03-04 0:01 ` Dmitry Gutov
2014-03-04 17:28 ` Glenn Morris
2014-03-04 18:05 ` Juanma Barranquero [this message]
2014-03-04 18:13 ` David Kastrup
2014-03-04 18:19 ` Juanma Barranquero
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='CAAeL0STgxsDXV4YvxBWsvB=r608XsH1uALNFedfmEmw-qyCkMw@mail.gmail.com' \
--to=lekktu@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=rgm@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.
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.