Difference between revisions of "Wales Group Version control"

From CUC3
Jump to navigation Jump to search
import>Csw34
import>Csw34
Line 18: Line 18:
 
What follows are a few suggestions to make using SVN a joyful experience. Please add any others you think are important! In general you should:
 
What follows are a few suggestions to make using SVN a joyful experience. Please add any others you think are important! In general you should:
   
* make sure you followed the setup instructions on the [[SVN setup]] page. The procedure includes setting up a template file. This ensures that all posts are in the same basic format
+
* make sure you followed the setup instructions on the [[SVN setup]] page. The procedure includes setting up a template file to ensure that all logs are in the same basic format
 
* run 'svn update' on a regular basis to ensure you have the latest bug fixes
 
* run 'svn update' on a regular basis to ensure you have the latest bug fixes
 
* '''always''' do an 'svn update' before you do 'svn commit'
 
* '''always''' do an 'svn update' before you do 'svn commit'

Revision as of 18:09, 11 July 2008

We are now in the final stages of putting the group code under version control. GMIN and PATHSAMPLE, along with the CHARMM and AMBER code used with them have been added to the repository. OPTIM will be added soon. Once stable versions of the source code have been added - the next step is to set up the nightly test suite for each code, and move the documentation into the repository.

There are instructions on how to set up your SVN details and obtain the group code on the SVN setup page.

RSS feeds

RSS feeds (including diffs of files that have been changed) are generated every 10 minutes from the SVN log files any uploaded to the CUC3 web server. There is currently one feed per top level directory in the repository:

  • trunk_log.xml - contains the logs/diffs for every change to the code
  • gmin_log.xml - only contains the logs/diffs when code in the GMIN directory is changed
  • pathsample_log.xml - only contains the logs/diffs when code in the PATHSAMPLE directory is changed
  • charmm_log.xml - only contains the logs/diffs when code in the CHARMM31 directory is changed
  • amber_log.xml - only contains the logs/diffs when code in the AMBER directory is changed

Using Firefox to look at the feeds is ok, but I suggest you set up a different RSS reader, such as Google Reader to keep them all in one place. Note that Google Reader has a delay in updating the feeds, so you wont see new logs up to an hour after they are created and are visible with Firefox.

Usage tips

What follows are a few suggestions to make using SVN a joyful experience. Please add any others you think are important! In general you should:

  • make sure you followed the setup instructions on the SVN setup page. The procedure includes setting up a template file to ensure that all logs are in the same basic format
  • run 'svn update' on a regular basis to ensure you have the latest bug fixes
  • always do an 'svn update' before you do 'svn commit'
  • commit your changes regularly. If you wait a two months before commit your changes, you're likely to have to resolve more conflicts in parts of the code that has been changed by others in the meantime.
  • if you get a conflict (C flag) when running 'svn update', find out who introduced the change and talk to them about it.