home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / cvs1929.zip / cvs / scripts / README < prev    next >
Text File  |  1998-08-02  |  3KB  |  102 lines
  1.  
  2. 1. Installation.
  3.  
  4.     - Checkout CVSROOT from your repository:
  5.  
  6.         md work
  7.         cd work
  8.         cvs co CVSROOT
  9.         cd CVSROOT
  10.  
  11.     - Copy the following files to the work\CVSROOT directory:
  12.  
  13.         commitinfo.cmd
  14.         loginfo.cmd
  15.         verifymsg.cmd
  16.         maildist
  17.         avail
  18.  
  19.     - Add the new files to your repository:
  20.  
  21.         cvs add commitinfo.cmd loginfo.cmd verifymsg.cmd
  22.         cvs add maildist avail
  23.  
  24.     - Add the following lines to checkoutlist:
  25.  
  26.         commitinfo.cmd
  27.         loginfo.cmd
  28.         verifymsg.cmd
  29.         maildist
  30.         avail
  31.  
  32.     - Edit maildist and/or avail to suit your needs.
  33.  
  34.         See the comments in the respective files on the format.
  35.         Be sure to read the comments in commitinfo.cmd and
  36.         loginfo.cmd first.
  37.  
  38.     - Add the following line to commitinfo:
  39.  
  40.         ALL            $CVSROOT/CVSROOT/commitinfo.cmd -r
  41.  
  42.         If you want to perform access control, add the -A option:
  43.  
  44.         ALL            $CVSROOT/CVSROOT/commitinfo.cmd -rA
  45.  
  46.     - Add the following line to loginfo:
  47.  
  48.         DEFAULT        $CVSROOT/CVSROOT/loginfo.cmd %s
  49.  
  50.         Note: If you want to email the commit messages (see maildist),
  51.         be sure to have a properly configured sendmail. You may also
  52.         want to setup .cvsauthors (see below) at this point, so loginfo
  53.         can determine the committers full name and email address to be
  54.         used as the 'From:' address for commit messages.
  55.  
  56.     - Now commit the changes:
  57.  
  58.         cvs commit -m "your log message"
  59.  
  60.     - Since CVS makes all the files in your repository's CVSROOT
  61.       directory read-only (thus preventing the Rexx interpreter from
  62.       saving the tokenized image), a little script is provided to
  63.       tokenize all read-only scripts in the local repository's CVSROOT
  64.       directory. Just run 'tokenize' from command line.
  65.  
  66.       Note: You have to re-tokenize each time you commit to CVSROOT.
  67.  
  68.     - You can now remove the work\CVSROOT directory.
  69.  
  70. 2. Maintaining a ChangeLog.
  71.  
  72.     To update the ChangeLog after you are through with your commits,
  73.     copy cvs2log.cmd into a directory in your path (preferrably the
  74.     one where cvs.exe already resides).
  75.  
  76.     Running cvs2log will recursively walk through the directories
  77.     updating the ChangeLog in each directory it visits. After
  78.     updating each ChangeLog, cvs2log will invoke the editor specified
  79.     by the CVSEDITOR environment variable (or a default editor, if
  80.     CVSEDITOR is not set). Setting CVSEDITOR to 'epm /m' is a good
  81.     choice. You are now given the opportunity to edit the ChangeLog.
  82.  
  83.     After cvs2log finishes its job, you may want to commit the ChangeLog.
  84.     If you didn't have a ChangeLog before running cvs2log, be sure to do
  85.     a 'cvs add ChangeLog' for each directory involved first.
  86.  
  87.     Be aware, though, that in a multi-developer environment, the ChangeLog
  88.     (as well as any other files you may have checked out) may be modified
  89.     by other developers as well, so be sure to perform an update and
  90.     resolve any conflicts first before hacking away.
  91.  
  92.     cvs2log uses the file .cvsauthors (see the comments on the format) to
  93.     determine the full name and email address from the login name. Add a
  94.     line that describes each committer and copy the file to the directory
  95.     specified by your %ETC% or %HOME% environment variable. Note however,
  96.     that %HOME% is usually a per user location, so you might want to use
  97.     %ETC% if more than one person is doing commits on your machine.
  98.  
  99.     The file .cvsauthors is also used by loginfo to determine the 'From:'
  100.     address for commit messages.
  101.  
  102.