Page History

h2. Background

Projects within the IEPM group are version controlled using [SubVersioN|http://subversion.tigris.org/].

A nice online manual of SVN usage and theory is located [here|http://svnbook.red-bean.com/en/1.2/index.html].

SVN is a version control system that enables groups of developers to code on the same software project and or files with little to no worries in terms of conflict of code. More importantly, it allows the branching and tagging of projects. Finally it provides a central repositry whereby developers can quickly and easily obtain the latest (or not so latest) versions of project code.

h2. SVN Command Primer

SVN works similarly to CVS. In as much as many of the commands are the same.

The basic concept is that the SVN Repositry holds all of the versions of the different code that all developers use.

Users/developers have to work on 'checked out' copies of the code from this central repository. Developers should ONLY make changes to this 'checked out' version; when they have tested and are happy with their changes, only then should they 'commit' their changes back into the repositoty for other developers.

Other developers must issue an 'update' command in order to get the changes from other developers (once they have committed them)

h3. SVN Help

Use the svn help command. (if you use man help this will point you to tethe svn help command): 

{code}
$ svn helpusage: svn <subcommand> [options] [args]
Subversion command-line client, version 1.4.3.
Type 'svn help <subcommand>' for help on a specific subcommand.
...
{code}

h3. SVN Checkout

In order to work on SVN projects, it is necessary to 'checkout' the project files. Given a project, you are expected to work on edits on a local copy from which editing and testing is to occur before the changes are 'checked in' back into the SVN repository.

You can check-out a project via:
{code}
$ cd /tmp/
$ svn co  file:///afs/slac.stanford.edu/g/scs/net/netmon/repo/svn/<project-name> my_project
{code}
This will retrieve the latest versions of the files contained within the SVN project <project_name> and place it into the directory {{/tmp/my_project}}. Note that this location is arbitary.

h3. Checking-In Edits

Once a SVN project has been checked out, files can be edited. Code should be tested to work on the local copy before committing the changes back into the SVN repository. The processes of committing the edits is called 'checking in' your files.

For example, should a file in your project have been edited, you can commit the changes back by:
{code}
$ cd /tmp/my_project
$ # edit, say, file /tmp/my_project/test
$ svn commmit
{code}

Unless the options {{\--message}} or {{\-m} are supplied, the editor specified in your {{EDITOR}} environment will open to prompt for some text input. This text will form the description of your edits and will be stored in the SVN log for the file(s). 
Please put something meaningful such as 'Fixed bug which caused text to display incorrectly' rather than 'Fixed bug'.

The processing of checking in edits will also scan for all files in the project (and recursively do so). 
If you wish to only commit changes to one or a select number of files, use the {{\--file}} or {-F} options.


h3. Adding Files to the Project

In order to add additional files after the initial import into a project, you must manually add files using the command:
{code}
$ cd /tmp/my_project
$ touch new_file.pl
$ svn add new_file.pl
$ svn commit
{code}
Once you have run the command, you must {commit} the action in order to place the newly created file into the repository (again it will prompt for some text describing the changes).


h3. Updating files&nbsp;

To simply update your copy of the file to the latest version use the update command:

{code}
$ cd /tmp/my_project$project
$ svn update 
{code}

h3. Administrative Details

[SVN Administrative Details|SVN Administrative Details].

h2. IEPM SVN Projects

What follows are the current SVN Projects that have been imported. Please keep this list upto date.

Note that the relative location is that of

{{/afs/slac.stanford.edu/g/scs/net/netmon/repo/svn/}} + Relative Location
|| Project Name || Relative Location || Description ||
| IEPM Base Libraries | iepm | This project contains the base/standard perl libaries that other project may depend upon. This should contain fundamental base classes that may or may not be extended/inherited by project specific modules. |
| IEPM-BW | iepm-bw | This contains the iepm-bw related modules and scripts such as that to query for the IEPM-BW database, maintaince scripts etc. |
| Netflow Analysis | netflow | For the Terapaths Project, this package contains the libraries, scripts and installation scripts required for the Netflow analysis backend and frontend |
| PingER | pinger | PingER related scripts and modules |
| [Topology Analysis|IEPM Topology Analysis Repository] | topology | Topology analysis tools such as {{traceanal}}, graphviz visualisation etc. |
| &nbsp;[Event Diagnosis |https://confluence.slac.stanford.edu/display/IEPM/Event+Diagnosis] | &nbsp;event_diagnosis | &nbsp;This project contains scripts related to event diagnosis. Two types of scripts are present in distributions. Those to be deployed on Central Node and those which should be deployed at Monitoring Node. |