Source Crusade - Leading the fight for better code
Source Metrix Logo

 

 

 

Project:

Source Metrix

Title :

User Manual

 

Compiled by :  

Bruce S. O. Adams

Date :

10-Apr-2006

 

 

 

 

 

Issue

Date

Author

Change

1.1

10-Apr-2006

BSA

Updated for initial preview release

1.0

12-Jan-2006

BSA

Initial Draft

 

 

 

 

 

 

 

 


1     Introduction.. 3

1.1      What is Source Metrix?. 3

1.2      Registration.. 3

1.3      Version.. 3

1.4      Requirements. 3

1.5      Contact Details. 3

2     Installation.. 4

3     Quick Start Guide. 4

4     How it works.. 4

5     Source Files.. 4

5.1      Source Types. 4

5.2      Default File Extensions. 4

6     Database. 5

6.1      Analysing Changes without storing them... 5

7     Metrics.. 5

7.1      Line based Metrics. 5

7.2      Statement based Metrics. 5

7.3      Density.. 5

7.4      Future Enhancements. 6

8     Reporting Functionality.. 6

8.1      Future Enhancements. 6

9     Interfacing with Version Control.. 6

9.1      Supported Version Control systems. 6

10       Historical Analysis.. 6

10.1     Why use historical analysis features?. 6

10.2     How to use the historical analysis feature. 6

10.3     Average Change. 7

10.4     Prediction.. 7

10.4.1     Future developments. 7

11       Change Grouping.. 7

11.1     What is a change group?. 7

11.2     How are change groups determined?. 7

11.3     How do I use this feature?. 8

11.4     Storing and overriding change groups. 8

12       Command Line Options Summary.. 8

12.1     Change Grouping Options. 9

13       Performance. 10