Quick CVS Notes for Instrument Specialists   (presented 24 March 2000)

***  In general, IS'es will probably be only performing the first five BASIC commands ***

---

BASIC Everyday Commands

• Verify what is different  in current working directory versus CVS repository   (where CVS repository has already been created by S/W folk) :
• cd ~INSTR/bin
• cvs -n up    [the '-n' means do NOTHING!]

 
        ... output could look like this :
        M  myfile1           [where 'M' means the current directory's 'myfile1' has been 'M'odified
                                     and should be committed back into CVS]

        U   myfile2         [where 'U'  means the CVS version has changed and the current
                                     directory should be 'U'pdated with the latest CVS version.  IS's
                                     should (hopefully!) not have to worry about this one because you
                                     all work out of the same directory, e.g., ~INSTR/bin. Use care.]

        ? myfile3           [where '?' means that CVS does not yet know about this file and it
                                      should be cvs 'added' and 'commited']

        A myfile4            [where 'A' means that the file has been CVS 'added', but not yet
                                     'committed']

        C myfile5            [where 'C' means there is a conflict within the file; e.g., there are
                                     conflicts resulting from the merged changes between what was in CVS
                                     and what was in the current directory; these should be resolved]

        R myfile6            [where 'R' means that the file has been marked for CVS removal but
                                     not yet 'committed']
 

• Displaying differences :
1.        Between the current directory's file and the most recent CVS version (*) :

           cvs diff myfile       [orcvs diff -rHEAD myfile to be safe]
2.        Between two different CVS versions :

           cvs diff -r1.3 -r1.2 myfile
3.        Between the current directory's file and a specific version in CVS :

          cvs diff -r1.2 myfile
• Checking changes back into CVS (to a file that has already been cvs 'added') :
• vi myfile
• cvs commit -m"added new setup parameters (IS)" myfile

 
• Viewing a file's CVS version history :
• cvs log myfile

 
• Adding a new file into the CVS repository :

(This command can also be applied to adding new subdirectories to the CVS repository.)
• cd ~INSTR/bin
• vi myfile
• cvs add myfile
• cvs commit -m"baseline of myfile (by IS)" myfile

---

INTERMEDIATE Commands

• To 'U'pdate the current working directory with the files from the CVS repository, or

 a specific version of a CVS file :
(use care since this command will overwrite the current directory's files with what CVS has!)
 
• cvs update                     [updates the directory w/ any latest CVS modifications]

 
• or cvs update -A myfile [to update directory with latest version of myfile only]

 
• or cvs update myfile   [to only update the directory with myfile, based on any sticky tag

                                       already defined for that file in ./CVS/Entries]
 
• or cvs update -r 1.2 myfile [to update directory with a previous version, e.g., 1.2, of myfile]

 
• * Note that this will cause a 'sticky tag' of '1.2' to be put on the file.  To remove the 'sticky tag',

  edit the ./CVS/Entries file and remove the 'T' (Tag) indicator from the file details.  For
  example :

  modify the line
           /obSubs.c/1.2/Tue Jul 18 18:40:57 2000//T
  to
           /obSubs.c/1.2/Tue Jul 18 18:40:57 2000//

• To remove a version of a file from CVS (careful!), e.g., remove vsn 1.3, but keep 1.2 :
• cvs admin -o1.3 myfile           [where 'o' stands for 'outdates']

 
• To TOTALLY remove a file from the current directory and CVS repository :
• rm myfileisjunk
• cvs remove myfileisjunk
• cvs commit -m"no longer needed (IS)" myfileisjunk

---

ADVANCED Commands

• Tagging file[s] for a particular release (so they can be retrieved by release tag in the future) :
• cd ~INSTR/top-of-my-source-tree
• cvs tag release-2-0   [where 'release-2-0' is just a named tag, use your own;

                            this will tag all files from top-of-my-source-tree down]
or
• cvs tag release-2-0 thisfile        [will only tag thisfile w/ 'release-2-0']

 
• Retrieving a set of files by tag specification   [use care! since this will zap any files not in that release] :
• cvs update -r release-2-0

• Adding a new subdirectory and its contents (files) to the CVS repository

(For example, adding a new display, newgui, to the /kroot/kui structure)
• cd ~/kroot/kui/newgui        [go to subdirectory where 'newgui' software exists]
• if you are on a summit machine, specify location of root CVS repository at HQ :

         setenv CVSROOT  /net/cvsserver/local/cvsroot
OR
         setenv CVSROOT  kics@hana.keck.hawaii.edu:/usr/local/cvsroot
OR
         setenv CVSROOT  kics@apua.keck.hawaii.edu:/usr/local/cvsroot
OR
If you are at an HQ machine, simply specify location of root CVS repository at HQ :
         setenv CVSROOT   /usr/local/cvsroot
 
• cvs import -m"baseline for newgui" kroot/kui/newgui ECC INITIAL

       [tell CVS to import all files in this subdirectory to a new CVS repository, kroot/kui/newgui;
        the files will actually go to HQ in /usr/local/cvsroot/kroot/kui/newgui;
        'ECC'  is the vendor-tag-comment, 'INITIAL' is the release-tag-comment]
 
• cd ../                                                [go up one level]
• mv newgui newgui.orig
• cvs checkout -d newgui kroot/kui/newgui    [checkout the files from CVS into a new subdirectory called newgui; this will also populate the necessary CVS subdirectories]

 
• when you are satisfied that the newly CVS-checked out directory newguihas all the files as in newgui.orig, then you can delete the original newgui.orig subdirectory
  
  
• Adding a new binary file to the repository:
• cvs add -kb -m"A test file" kotest
• cvs ci -m"First checkin; contains a keyword" kotest

 
• If a binary file accidentally gets added without '-kb', one can use the cvs admin command to recover.  
  For example:
• cvs add -m"A test file" kotest
• cvs ci -m"First checkin; contains a keyword" kotest
• ....WHOOPS didn't set it binary! Fix using admin:
• cvs admin -kb kotest
• cvs update -A kotest
  
  
• # For non-unix systems:
• # Copy in a good copy of the file from outside CVS
• cvs commit -m "make it binary" kotest

---

NOTES

• CAREFUL!  Do not  CVS 'commit' soft links as this will zero out the file!
• For example, you have a link thisTest that is simply a link to an actual file, thisTest.v1 :

   thisTest -> thisTest.v1
• cvs commiting the link thisTest will put it in the CVS repository as a zero length file, remove the link to thisTest.v1 and thisTest will become a zero-length file in your working directory!

 
• To get CVS help :
• man cvs
• or  cvs -- help
• or  cvs add --help
• or call Allan or Liz   :)