StatSvn Documents

6 messages

StatSvn Documents

Reply Threaded

Hail!

This is my first mail sent to the StatSvn Developers Mail List, so it would be good if I introduce myself before anything, it isn't!?

So, my name is André.I'm a brazilian Computer Science student (3rd year) and I'm 20 years old.

I'm usign the StatSvn on my Treinee work and we want to improve the "changed line" metrics of the software.
I got the StatSvn and the StatCvs source code, but it's being very difficult to understand very well the components without a specification.

Would you have any documents about the internal structure of the software!?
One of my biggest difficults is to undestand the logic behind the Revision and RevisionData classes (why do they need to be different?) and the numbers shown on the Developers Page and the Commit Logs Page.

Thanks.
André.

PS: If I had done any mistake with the English language, please, tell me. I will be glad to improve my English language domain.

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Statsvn-developers mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/statsvn-developers

Jean-Philippe Daigle

Re: StatSvn Documents

Reply Threaded

On Thu, Aug 7, 2008 at 7:47 AM, André Zanchetta <[hidden email]> wrote:

Hail!

This is my first mail sent to the StatSvn Developers Mail List, so it would be good if I introduce myself before anything, it isn't!?

So, my name is André.I'm a brazilian Computer Science student (3rd year) and I'm 20 years old.

I'm usign the StatSvn on my Treinee work and we want to improve the "changed line" metrics of the software.
I got the StatSvn and the StatCvs source code, but it's being very difficult to understand very well the components without a specification.

Would you have any documents about the internal structure of the software!?
One of my biggest difficults is to undestand the logic behind the Revision and RevisionData classes (why do they need to be different?) and the numbers shown on the Developers Page and the Commit Logs Page.

Thanks.
André.

PS: If I had done any mistake with the English language, please, tell me. I will be glad to improve my English language domain.

Hi André, there aren't a lot of formal docs, but one thing you might find useful is a short whitepaper Jason wrote while he was doing his master's degree. It's here:
http://www.softwareengineering.ca/statsvn/CSI5140_StatSVN.pdf

It explains some of the workings of StatSVN. As for your postscript about English, don't worry too much, many of us (like Jason and I) aren't native speakers of English either.

Jean-Philippe Daigle

Jason Kealey-2

Re: StatSvn Documents

Reply Threaded

In reply to this post by André Zanchetta

Some javascript/style in this post has been disabled (why?)

Hi André,

As JP told you, we don’t have much information on either projects. StatSVN was implemented by reading the StatCVS code only, and the artefact that was produced is our whitepaper:

http://www.softwareengineering.ca/statsvn/CSI5140_StatSVN.pdf

However, this was done a few years ago and I am a bit rusty. What I do remember is that the classes in the input.* package (such as RevisionData) are created while parsing the log whereas the ones in the model.* package (such as Revision) are later generated according to the information gathered. StatCVS/StatSVN uses the builder design pattern (http://en.wikipedia.org/wiki/Builder_pattern).

Since you are looking to improve the changed line metrics in StatSVN, you will need to look at SvnDiffUtils. This class currently looks at the + and – symbols in a diff, whereas you are probably looking to review this class and create a new SvnCatUtils (http://svnbook.red-bean.com/en/1.0/re03.html) to parse the contents of the files.

Good luck! If you write up documentation that can benefit other developers, that would be great!

Thanks,

---

Jason Kealey - [hidden email]

LavaBlast Franchise Software - http://www.lavablast.com

Simplifying day-to-day franchise operations

From: André Zanchetta [mailto:[hidden email]]
Sent: August-07-08 7:47 AM
To: [hidden email]
Subject: StatSvn Documents

Benoit Xhenseval-2

Re: StatSvn Documents

Reply Threaded

In reply to this post by André Zanchetta

Hi Andre,

If we re-org the code, whenever possible, we should try to avoid static methods/classes, especially if we want some algorithms to be interchangeable, eg run statcvs/statsvn with ALL-line calculator or 'all-line without comments' etc

Quick comment from Cyprus!

All the best,

Benoit
------------------------------
IMPORTANT NOTICE
This communication contains information that is considered confidential and may also be privileged . It is for the exclusive use of the intended recipient(s). If you are not the intended recipient(s) please note that any form of distribution, copying or use of this communication or the information in it is strictly prohibited and may be unlawful. If you have received this communication in error please return it to the sender and delete the original.

-----Original Message-----
From: "Jason Kealey" <[hidden email]>

Date: Thu, 7 Aug 2008 10:52:47
To: 'AndrÃ© Zanchetta'<[hidden email]>; <[hidden email]>
Subject: Re: [Statsvn-developers] StatSvn Documents

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/
_______________________________________________
Statsvn-developers mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/statsvn-developers

André Zanchetta

Re: StatSvn Documents

Reply Threaded

Hail guys,
thanks for the informations. I was able to make the modifications I was trying to do. If anyone of you wants to dicuss about this topic (modified lines count), I would be glad to show my opinion.
About the documentation, I really want to contribuate with an open-source project, and creating the documentation is not a bad idea. However, I have few time to spend on that... I will probably take around FOUR months to finish it. This is of course too long...

Finishing: what kind of documentation are usually done in open-source projects?

On Thu, Aug 7, 2008 at 4:07 PM, Benoit Xhenseval <[hidden email]> wrote:

Hi Andre,

If we re-org the code, whenever possible, we should try to avoid static methods/classes, especially if we want some algorithms to be interchangeable, eg run statcvs/statsvn with ALL-line calculator or 'all-line without comments' etc

Quick comment from Cyprus!

All the best,

Benoit
------------------------------
IMPORTANT NOTICE
This communication contains information that is considered confidential and may also be privileged . It is for the exclusive use of the intended recipient(s). If you are not the intended recipient(s) please note that any form of distribution, copying or use of this communication or the information in it is strictly prohibited and may be unlawful. If you have received this communication in error please return it to the sender and delete the original.

-----Original Message-----
From: "Jason Kealey" <[hidden email]>

Date: Thu, 7 Aug 2008 10:52:47
To: 'AndrÃ© Zanchetta'<[hidden email]>; <[hidden email]>
Subject: Re: [Statsvn-developers] StatSvn Documents

-------------------------------------------------------------------------
This SF.Net email is sponsored by the Moblin Your Move Developer's challenge
Build the coolest Linux based applications with Moblin SDK & win great prizes
Grand prize is a trip for two to an Open Source event anywhere in the world
http://moblin-contest.org/redirect.php?banner_id=100&url=/

Jason Kealey-2

Re: StatSvn Documents

Reply Threaded

Some javascript/style in this post has been disabled (why?)

Hi André,

Feel free to show us the changes you’ve made. Depending on the project, there can be much more documentation in an open source project than in a closed source one. StatSVN does not have much, but is a fairly small project with a low number of contributors.

Thanks,

Jason

From: [hidden email] [mailto:[hidden email]] On Behalf Of André Zanchetta
Sent: August-12-08 9:30 PM
To: [hidden email]
Cc: [hidden email]; Statsvn; Jason Kealey
Subject: Re: [Statsvn-developers] StatSvn Documents

On Thu, Aug 7, 2008 at 4:07 PM, Benoit Xhenseval <[hidden email]> wrote: