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

Re: Version change rationale.

From: Jared Hardy <jaredhardy_at_gmail.com>
Date: 2007-01-11 06:31:37 CET

On 1/10/07, Owen Thomas <othomas@wcg.net.au> wrote:
> > It can even be changed later, after commit.
>
> Now that's a definite point against the use of svn:log for recording
> change rationale.

As Matt said, the default server behavior is not to allow you to
change the log. There exist pre-commit-hook script options to allow
this, in case anyone would want this in their own rationale log
system.

> > You can format this text data any way you want, CSV, ODF, XML,
> > YAML, INF, CONF, etc. Or make up your own format.
>
> As said in an earlier post, if I can have this, I will.

Yes, but what I'm saying is that these formats can be embedded in the
svn:log text. You can then just pipe it into a file to read later,
rather than keeping a versioned file locally.

> Gee, I salivate at the chance of getting this fancy. I might supply the
> list of files included in the change in the svn:log entry.

You already get this list of files when you use the "svn log URL -v"
verbose command. What I meant by listing the files is creating
individual fields for rationale entries for each changed file. If you
parse this and pipe the file-field data into individual rationale
files, the net effect becomes just like versioning rationale files for
each file on each commit.

> > Likewise, you may want to wrap any "svn log" command to return some
> > method of opening any svn:log or rationale-file entry in the list
> > in your desired editor/viewer.
>
> Hmmm... not too sure what you are driving at here. I'd love an
> explanation.

Let's say you have a log GUI like TortoiseSVN. You might want to be
able to hit a link next to each revision, and have all the rationale
documents for that revision open in a viewer. Or choose the revision,
and hit a link next to a specific file in the revision list, and thus
open its individual rationale file in the viewer. On the command line,
let's just say you enter a command like "svn log URL [-v]" to print
the repository log. For each revision number, you just get a log
summary, and list of files. Now, if you run "crlog URL <revnum> [-f
<filename>]" it opens the rationale doc(s) corresponding to revnum,
optionally opening just the doc for filename.

    Since you already seem to be working on your automated rationale
document co-versioning system, maybe you just want to add a reference
to the document(s) in every commit log. You could end each log message
with a path or list of paths to all the related rationale documents.
Then anyone could cut-n-paste the paths, to open the relevant
document. Or automated tools could parse the log and open the
rationale files based on revision number and filename.
    I'm not sure about the details, but it may be possible to set up
custom svn:x properties. You might be able to use a custom property to
automate the association between files and their rationale document.
Maybe something similar to the svn:bugtraq property.

:) Jared

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Thu Jan 11 06:31:54 2007

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