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

Re: FW: Version change rationale.

From: Jeff Smith <jsmith_at_robotronics.com>
Date: 2007-01-12 00:51:26 CET

On Wednesday 10 January 2007 21:45, Owen Thomas wrote:

> > Document" under version control just like any other file
>
> Precisely. The only thing I think I need to do is fashion a
> pre-commit script that makes sure that the rationale document has
> been altered (or created for a new module) when that module is
> being checked in. The script also needs to check the format of the
> document to ensure that it has been updated in the simple ways I
> have outlined earlier.

I gather you are saying you want to require consistency... certain
filename in each subfolder, certain format, but wait... "makes sure
that the rationale document has been altered" ? I'd think it would be
too involved to determine whether the developer has added useful
information like "improved this code for speed", or "let's go throw
Owen in a lake while he's asleep". Hopefully I'm misunderstanding
what you mean :)

> I'll have a go at doing this myself, but I would have thought that
> others had done something similar. I would save another wheel.

I see that you agree now that subversion itself doesn't need a new
feature. In fact, you are just defining your own company policy.
That's fine.

Yes, I do have this "rationale" documentation that you talk about. The
documentation is streamlined into my project source code. It's called
"comments". They are an amazing invention, and I'm certainly glad
that they are under version control in sync with the source code
itself. There are even a plethora of tools out there for generating
an entire help document for the application, by embedding markup text
into the comments which I can compile into html documentation using
doxygen.

It's all there. I wouldn't want you to have to reinvent the wheels
again.

---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@subversion.tigris.org
For additional commands, e-mail: users-help@subversion.tigris.org
Received on Fri Jan 12 00:52:35 2007

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