[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: RFC: Log Message Templates via new hook.

From: Julian Foad <julianfoad_at_btopenworld.com>
Date: 2005-05-26 03:54:30 CEST

Mark Phippard wrote:
> TSVN could then have a button to replace the variable with the file list
> and/or do it automatically when the user submits the commit.

That raises an interesting point. Why does anyone want a list of the files in
their log message template? Answer: to help them write their log message, by
reminding them what files changed and/or by providing some of the text around
which they will write descriptions. For example, in the Subversion project we
usually want the file names to end up in the log message as paths relative to
trunk or branch, preceded by an asterisk and followed by a description. If the
template can get part way there, that's useful.

It is not useful to have the list of files inserted just before commit, without
giving the user a chance to edit it. That would result in simple duplication
of information that is programmatically available. (If an administrator
insists that he wants that behaviour, his pre-commit hook can do it.)

For the purpose of reminding the user which files have changed, a GUI can
display that information as well as or better than a textual list.

That leaves one reason why a GUI could want a list of files in the log message
template: to provide some of the text around which the user will write
descriptions. Or at least text which is there for the user to selectively use
and edit.

What does this mean for TortoiseSVN? Taking the Subversion project's log
message style as an example again (other real-world examples welcome), we see
now that while TSVN is generating the file list, the user could be writing the
log message introduction and general description. Then the file list should be
inserted, and then the user can go on writing the detailed part of the log message.

Further, I would say that the file list really must be automatically formatted
in the project's chosen style. If it were presented always in a built-in fixed
style, then it would not really be very useful in providing a starting point
for the user's text, and would only really be a reminder.

- Julian

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@subversion.tigris.org
For additional commands, e-mail: dev-help@subversion.tigris.org
Received on Thu May 26 03:55:08 2005

This is an archived mail posted to the Subversion Dev mailing list.