From: Dan Nicolaescu <dann@ics.uci.edu>
To: Ted Zlatanov <tzz@lifelogs.com>
Cc: emacs-devel@gnu.org
Subject: Re: VC commit missing ChangeLog message
Date: Wed, 12 Nov 2008 23:09:35 -0800 (PST) [thread overview]
Message-ID: <200811130709.mAD79ZoN009164@mothra.ics.uci.edu> (raw)
In-Reply-To: <86ej1gfwop.fsf@lifelogs.com> (Ted Zlatanov's message of "Wed, 12 Nov 2008 15:42:30 -0600")
Ted Zlatanov <tzz@lifelogs.com> writes:
> On Wed, 12 Nov 2008 11:56:42 -0800 (PST) Dan Nicolaescu <dann@ics.uci.edu> wrote:
>
> DN> Ted Zlatanov <tzz@lifelogs.com> writes:
> >> On Tue, 11 Nov 2008 17:11:06 -0800 (PST) Dan Nicolaescu <dann@ics.uci.edu> wrote:
> >>
> DN> If you are interested in improving this area, please also look at one of
> DN> the TODO items in vc.el:
> >>
> DN> ;; - When vc-next-action calls vc-checkin it could pre-fill the
> DN> ;; *VC-log* buffer with some obvious items: the list of files that
> DN> ;; were added, the list of files that were removed. If the diff is
> DN> ;; available, maybe it could even call something like
> DN> ;; `diff-add-change-log-entries-other-window' to create a detailed
> DN> ;; skeleton for the log...
> DN> ;;
> >>
> >> I think that should be up to the user, to be done in the hook.
>
> DN> Sure, but it would be nice to provide a way to do it by default.
>
> I think we agree that something is good, but it will be hard to agree on
> the particulars of what to put in the buffer. So maybe the answer is a
> format-like string (falling back to a function call) that the user can
> customize?
Or a list of functions?
> >> The information, diff and files added/removed/affected, exists
> >> outside the commit message so putting it inside the message
> >> duplicates the information.
>
> DN> It exists, but it means you have to look in two places for it, it is
> DN> customary to put such information in the logs.
>
> Sorry, I don't see what you mean. Putting it in the logs would ensure
> you have two places to look, and when it's inaccurate it would be an
> even worse situation.
See many the logs for many GNU projects (including emacs), file addition
and deletions are noted there, it's quite usual to do so.
> DN> Also you only addressed one part of that TODO entry, the whole point is
> DN> to make it easier to write log entries, and provide as much as possible
> DN> by default.
>
> The two goals diverge significantly once the threshold of "enough"
> information is passed, and unfortunately that is a different point for
> every user.
>
> Specifically regarding the detailed skeleton, I think we're getting to
> the format string/function concept I mentioned above. I don't think
> Emacs has a default way to do this, but skeleton.el should work.
IMHO the ChangeLog format
* filename (FUNCTION_NAME):
should be enough for the start, we'll see if users ask for a different
format. The format is probably not that important for the beginning...
next prev parent reply other threads:[~2008-11-13 7:09 UTC|newest]
Thread overview: 23+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-11-11 14:41 VC commit missing ChangeLog message Ted Zlatanov
2008-11-11 14:49 ` Alfred M. Szmidt
2008-11-11 16:25 ` Stefan Monnier
2008-11-11 16:43 ` Ted Zlatanov
2008-11-11 16:58 ` Dan Nicolaescu
2008-11-11 19:11 ` Ted Zlatanov
2008-11-11 19:45 ` Dan Nicolaescu
2008-11-11 21:38 ` Ted Zlatanov
2008-11-12 1:11 ` Dan Nicolaescu
2008-11-12 17:17 ` Ted Zlatanov
2008-11-12 19:42 ` Stefan Monnier
2008-11-12 19:59 ` Dan Nicolaescu
2008-11-12 20:57 ` Stefan Monnier
2008-11-12 21:47 ` Ted Zlatanov
2008-11-13 1:56 ` Stefan Monnier
2008-11-12 19:56 ` Dan Nicolaescu
2008-11-12 21:42 ` Ted Zlatanov
2008-11-13 7:09 ` Dan Nicolaescu [this message]
2008-11-13 14:47 ` Ted Zlatanov
2008-11-13 15:12 ` Dan Nicolaescu
2008-11-12 2:38 ` Stefan Monnier
2008-11-11 17:41 ` Stefan Monnier
2008-11-11 19:09 ` Ted Zlatanov
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=200811130709.mAD79ZoN009164@mothra.ics.uci.edu \
--to=dann@ics.uci.edu \
--cc=emacs-devel@gnu.org \
--cc=tzz@lifelogs.com \
/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.