Differences between revisions 5 and 30 (spanning 25 versions)
Revision 5 as of 2008-03-29 15:52:19
Size: 3258
Comment:
Revision 30 as of 2012-02-01 11:45:49
Size: 2103
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
#acl AdminGroup:read,write,delete,revert All:
Line 4: Line 2:

== Usage ==
First, [[https://surfer.nmr.mgh.harvard.edu/opensourcereg.html|register to receive the password to this repository]]. This registration form includes [[FreeSurferSoftwareLicense|the license terms]]. Note: tkmedit, tksurfer and tkregister2 are covered under [[FreeSurferCorTechsLicense|the CorTechs license]].
Line 8: Line 5:
Line 9: Line 7:
cvs -d :pserver:anonymous@fscvs.nmr.mgh.harvard.edu:/usr/fscvsroot login cvs -d :pserver:anonymous@fsvm.nmr.mgh.harvard.edu:/usr/fscvsroot login
Line 11: Line 9:
press Enter when prompted for the password (there isn't one). Then type: You will supply the password received via email after completing the registration form. Then type:
Line 13: Line 12:
cvs -d :pserver:anonymous@fscvs.nmr.mgh.harvard.edu:/usr/fscvsroot checkout dev cvs -d :pserver:anonymous@fsvm.nmr.mgh.harvard.edu:/usr/fscvsroot checkout -P dev
Line 15: Line 14:
This will begin the download of the source-code trunk, creating a directory named 'dev'. This will begin the download of the source-code trunk, creating a directory named 'dev'.  The -P flag will purge the junk files that have been deleted from the repository over the years.
Line 17: Line 16:
To get a copy of the current 'stable' branch (the code used to build the public release), insert '-r stable4' before 'dev' in the second command, like this: To get a copy of the current 'stable' branch (the code used to build the public release but that has been internally updated with bug fixes), insert '-r stable5' before 'dev' in the second command, like this:
Line 19: Line 19:
cvs -d :pserver:anonymous@fscvs.nmr.mgh.harvard.edu:/usr/fscvsroot checkout -r stable4 dev cvs -d :pserver:anonymous@fsvm.nmr.mgh.harvard.edu:/usr/fscvsroot checkout -P -r stable5 dev
Line 21: Line 21:
Note that this will also create a directory named 'dev', so you should probably create a directory named 'stable4', cd to that, and then do the checkout. Note that this will also create a directory named 'dev', so you should probably create a directory named 'stable5', cd to that, and then do the checkout.

If you need the version used in the 5.1 public release, then use 'release_5_1_0' as the revision tag (instead of 'stable5').
Line 24: Line 26:
Line 33: Line 36:
Line 36: Line 40:

== Maintenance ==
This section documents how the read-only CVS server was setup. It is intended for Martinos Center developers.

A VM named fscvs was setup on surfer, which implements an instance of Linux Centos to appear on the web as fscvs.nmr.mgh.harvard.edu. On this virtual machine, in the directory {{{/usr/fscvsroot}}}, there is a copy of the real (read/write) CVSROOT (which is found on the NMR NFS network). The cvs pserver functionality is used to serve this repository copy. That was setup by creating a file called {{{cvspserver}}} in the directory {{{/etc/xinetd.d}}}, where the file contains:
{{{
service cvspserver
{
 port = 2401
 socket_type = stream
 protocol = tcp
 wait = no
 user = root
 passenv = PATH
 server = /usr/bin/cvs
 server_args = -f --allow-root=/usr/fscvsroot pserver
}
}}}
If that is ever changed, you will need to type {{{service xinetd reload}}} to restart that service.

Now, how does the copy of the real CVS get from its location on the NMR network to fscvs? That is performed via two cronjobs. One is run as 'nicks', on the machine 'minerva', which runs the script {{{/space/freesurfer/scripts/cp_fscvs}}}, which tars the real CVSROOT, excluding the files we don't want to make public, and deposits that file in a 'nicks' temp directory. This is run every night at 2:00AM. Then, on fscvs, a 'root' cronjob, run at 2:10AM every night, runs the script {{{/usr/fscvsroot/update_fscvs}}}, which scp's the tarball from nicks temp directory to /usr/fscvsroot, untars it, and performs some permission changing.

On fscvs, the file {{{/usr/fscvsroot/CVSROOT/passwd}}} specifies the valid usernames. The {{{update_fscvs}}} script creates an empty passwd file, except for the username 'anonymous'.
See also [[ReadOnlyCVSadmin|admin notes]].

Access the read-only CVS source-code repository

First, register to receive the password to this repository. This registration form includes the license terms. Note: tkmedit, tksurfer and tkregister2 are covered under the CorTechs license.

To check-out a copy of the main 'dev' (development) trunk, type this:

cvs -d :pserver:anonymous@fsvm.nmr.mgh.harvard.edu:/usr/fscvsroot login

You will supply the password received via email after completing the registration form. Then type:

cvs -d :pserver:anonymous@fsvm.nmr.mgh.harvard.edu:/usr/fscvsroot checkout -P dev

This will begin the download of the source-code trunk, creating a directory named 'dev'. The -P flag will purge the junk files that have been deleted from the repository over the years.

To get a copy of the current 'stable' branch (the code used to build the public release but that has been internally updated with bug fixes), insert '-r stable5' before 'dev' in the second command, like this:

cvs -d :pserver:anonymous@fsvm.nmr.mgh.harvard.edu:/usr/fscvsroot checkout -P -r stable5 dev

Note that this will also create a directory named 'dev', so you should probably create a directory named 'stable5', cd to that, and then do the checkout.

If you need the version used in the 5.1 public release, then use 'release_5_1_0' as the revision tag (instead of 'stable5').

Build instructions are found in the DevelopersGuide, but in any case, you will first need to type this:

cd dev
./setup_configure

which will setup the autoconf and automake files for your platform. You need only do this once (or whenever you change configure.in).

The DevelopersGuide will describe how to need to configure, make, and make install.

Remember that cvs will cache the location of CVSROOT (the 'pserver' string from above), so to perform an update, you need only type:

cvs update -d

See also admin notes.