SVTVME pacakge maintenance

basic rules:

• All files whose name start with "svtsim_" are supposed to be copies of corresponding files in OFFLINE CVS. They must never be changed in online CVS other than to import (tested) offline version. Make sure you comply with this and use following indications as guideline, not golden rule. Make sure you read and uderstand Bill's page on how to handle online code

• make sure you read Thomas's SVT software page first, especially the introduction to CVS usage.
• all code/headers/doc is in online cvs repository (setup cvs -q online).
• changes in cvs repository are done with individual user names.
  NEVER, NEVER make changes in cvs as cdf_svt or similar.
• instead handling of ups packages (i.e. of source/doc/libraries/binaries etc. made available to users on the cdf online disk via the setup svtvme command) is NOW (as of Jan 15, 2006) done by user cdfprod.
• read Jim Patrick's tutorial in here also a lot of usefull stuff about e.g. ups and setup is in the online software pages.
• usefull pointers:
  • CVS home
  • UPS/UPD manuals
  • make
  • gmake (ps)
  • gmake (html)
• setup svtvme will setup the current fision version. This may or may not be the best choice. As of March 2001, this is 2_15 which is fine.
• Since October 2007 please use b0desktop02 (SL4) as the main system for compilations & testing Official updates using the svtvme_update_k5 procedure will do Linux and VxWorks flavors.
• Kerberos is required for online machines. So in the following I only give instructions that require a kerberos ticket. Also note that to log on an online machine from offsite (or a laptop using DHCP !) you need to log into antoher on-site CDF machine first.
• What version of the libraries are loaded on the crates?
  First look at file "~cdfprod/vxboot/ups/svtb.table" to see what version is setup.
  Then look at file "~vxworks/boot/front-end/startup.svt" to make sure it is loading the version setup above.
  Then check if the version loaded is a link to another version in directory ~cdfprod/LIBNAME (LIBNAME= svtvme, svtmon)

how to make changes in CVS repository

1. get a kerberos ticket and log on b0*****
2. create a work directory: e.g. mkdir ~/work
3. setup cvs -q online
4. cd ~/work
5. cvs checkout svtvme
   • cvs creates the directory svtvme and all the tree below it
6. cd svtvme
7. look at setup_local scriprt in this directory, it has the command:
   setup svtvme -r ${PWD} -M ups -m svtvme.table
   you must execute this command so the svtvme logicals point to this new work area, rather then to the real package directory on the online code disk. Then:
8. gmake
9. gmake ppc
   • OBSOLETE: this makes local copies of libraries. If you want to test local copied of VxWorks libraries as well, you need to re-issue the previous setup command (from svtme directory, not svtvme/src !) with qualifier -qppc and then -q68k. And re-run gmake (in svtvme/src) each time. Also you need to log b0dau30 machine and run gmake to make Irix library. I recommend to test Irix compiler when making big changes, it has different pickyness then gcc or $VXCC that helps getting code straight.
10. cd src
11. edit/change/test/.... source code
12. similarly on header files in /include etc.
13. when done: cvs commit -m"comment" file_name for each file you changed, or commit -m"comment" with no file name if same comment applies to all changed files
    • not all users can commit. At present ukyang,barchies,spinella,sdonati,belforte,rescigno,speer,ashmansk,sarkar and zanetti can. Ask Jim Patrick for permission if needed (or ask Stefano or Bill to ask it for you). Or ask them to put in the new code.
    • list of authorised is in b0dau30:/cdf/code/cvs/CVSROOT/check_access (only accessible on b0dau30 !)

how to make changes in development version of the package
(development version is just the head of the repository)

• please check that development version of svtvme is not used for data taking.
  just do "ls -l ~cdfprod/svtvme" and check that "current" is not a link to "development".
  If you do NOT check and development is pointed by the "current" link you may screw up data taking.
  
• Easy and fast via kerberised script: just type ~cdf_svt/svtvme_update_k5
  • for this to work your kerberos principal has to be listed in ~cdfprod/.k5login. If not so, ask someone who has his/hers there to add you.
  • WARNING: SVTSPYMON needs to be recompiled. See next instructions
• slow and tedious to control all details
  1. put the new code in cvs as for above procedure
  2. get a kerberos ticket on b0desktop02 and type: ksu cdfprod
  3. setup cvs -q online
  4. setup svtvme -d
  5. cd $SVTVME_DIR
  6. cvs update -d
  7. gmake
  8. setup svtvme -q ppc -d
  9. gmake
  10. WARNING: SVTSPYMON needs to be recompiled. See next instructions

how to test the development version

1. update the development version as above
2. log in b0desktop02 as cdfprod
3. make a symbolic link called "current" pointing to it
   
   • setup svtvme -d (or any other version)
   • cd $SVTVME_DIR
   • cd ..
   • ls -l (remember which version is "current")
   • ln -s development current (use -sf to override previous link)
4. recompile the current version of SVTSPYMON with
   • setup svtmon -q ppc
   • cd $SVTMON_DIR/src/monitor
   • gmake
5. reboot all the involved crates (TO BE USED WITH CARE: ~annovi/useful/rebootSVT.sh)
6. test it as necessary
7. if NOT satisfied with it
   • change back the "current" link to point to last good version
   • recompile SVTSPYMON as above
   • reboot all crates (TO BE USED WITH CARE: ~annovi/useful/rebootSVT.sh)
8. if satisfied with it
   • make a new frozen release as described next
   • make it current as described at bottom of this page

How to make a new frozen version of the package (or new release),
for example v5_18, i.e. something users will access with: setup svtvme v5_18

1. test first as development as above
2. when happy put release comments in README file
3. when happy with head of repository status tag it in cvs from your individual account with
   • cvs tag v5_18
4. log in b0desktop02 as cdfprod
5. setup cvs -q online
6. setup svtvme -d (or any other version)
7. cd $SVTVME_DIR/..
8. cvs checkout -r v5_18 -d v5_18 svtvme
9. cd v5_18
10. now must declare this to ups so setup can work:
    1. ups declare -f NULL -r ${PWD} -M ups -m svtvme.table -z /cdf/onln/code/cdfprod/upsdb svtvme v5_18
    2. ups declare -f NULL -q ppc -r ${PWD} -M ups -m svtvme.table -z /cdf/onln/code/cdfprod/upsdb svtvme v5_18
11. setup svtvme v5_18
12. gmake
13. gmake ppc

how to load a new SVTVME relase on the crates

1. make a new release following instruction above
2. make a symbolic link called "current" to the release e. g.
   
   • setup svtvme -d (or any other version)
   • cd $SVTVME_DIR
   • cd ..
   • ln -s v5_18 current (use -sf to override previous link)
3. recompile the current version of SVTSPYMON with
   • setup svtmon -q ppc
   • cd $SVTMON_DIR/src/monitor
   • gmake
4. reboot all the involved crates (TO BE USED WITH CARE: ~annovi/useful/rebootSVT.sh)
5. MAKE AN ENTRY IN THE SVT ELOG!