home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / unix / volume22 / cvs-berliner / part01 / README < prev   
Encoding:
Text File  |  1990-06-07  |  6.0 KB  |  147 lines
  1. $Id: README,v 1.3 89/11/19 23:15:11 berliner Exp $
  2.  
  3.  
  4.                CVS Kit, Version 1.0
  5.  
  6.             Copyright (c) 1989, Brian Berliner
  7.  
  8.     This program is free software; you can redistribute it and/or modify
  9.     it under the terms of the GNU General Public License as published by
  10.     the Free Software Foundation; either version 1, or (at your option)
  11.     any later version.
  12.  
  13.     This program is distributed in the hope that it will be useful,
  14.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  15.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.     GNU General Public License for more details.
  17.  
  18.     You should have received a copy of the GNU General Public License
  19.     along with this program; if not, write to the Free Software
  20.     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21.  
  22. --------------------------------------------------------------------------
  23.  
  24. This is the first release of CVS -- Concurrent Version System.
  25.  
  26. CVS is a freely available collection of programs that provide for software
  27. release and revision control functions in a UNIX environment.  It is
  28. designed to work on top of the RCS distribution, V4 (uses the V4 branch
  29. support).  CVS does understand how to parse older RCS formats, but cannot
  30. do any of the fancier features (like vendor branch support) without RCS
  31. branch support.
  32.  
  33. The conflict-resolution algorithms and much of the administrative file
  34. definitions of CVS were based on the original package written by Dick Grune
  35. at Vrije Universiteit in Amsterdam, and posted to comp.sources.unix in the
  36. volume 6 release sometime in 1986.  This original version was a collection
  37. of shell scripts. 
  38.  
  39. Brian Berliner from Prisma, Inc. converted the original CVS shell scripts
  40. into reasonably fast C and added many, many features to support software
  41. release control functions.  See the manual page in the "man" directory, and
  42. a copy of the USENIX article presented at the Winter 1990 USENIX
  43. Conference, Washington D.C., is included in the "doc" directory.
  44.  
  45. This code has been tested extensively on Sun-4 and Sun-3 platforms, all
  46. running SunOS 4.X.  Your mileage may vary for other systems, and I would
  47. really appreciate hearing back on what was necessary to get this beast
  48. working on other platforms.
  49.  
  50. Installation:
  51.  
  52. 1)  Edit the top-level Makefile (in this directory) and set DESTDIR to the
  53.     location of local binaries.  Also adjust CFLAGS and LDFLAGS
  54.     appropriately as well.  May also need to edit the man/Makefile file to
  55.     be sure that manual pages will be dropped in the correct place for your
  56.     system.
  57.  
  58. 2)  Edit the src/cvs.h header file.  Appropriate things to look at may be
  59.     the hard-coded locations of programs like DIFF, GREP, RM, and SORT.
  60.     Also glance at the default values for the environment variables that
  61.     CVS uses, in particular, the RCSBIN variable, which holds the path to
  62.     where the RCS programs live on your system.
  63.  
  64. 3)  make depend
  65.  
  66.     To get the Makefiles to use *your* include dependencies, not mine.
  67.  
  68. 4)  make
  69.  
  70.     This will (hopefully) make the needed CVS binaries within the "src"
  71.     directory.
  72.  
  73. 5)  make install
  74.  
  75.     If all goes well above, install the binaries and manual pages.
  76.     Depending on your instrallation's configuration, you may need to be
  77.     root to do this.
  78.  
  79. 6)  man cvs
  80.  
  81.     Take a look at the CVS manual page to see what it can do for you, and
  82.     if it fits your environment (or can possibly be made to fit your
  83.     environment).  If things look good, continue on...
  84.  
  85. 7)  Setup the master source repository.  Choose a directory with ample disk
  86.     space available for source files.  This is where the RCS ",v" files
  87.     will be stored.  Say you choose "/src/master" as the root of your
  88.     source repository.  Make the CVSROOT.adm directory in the root of the
  89.     source repository:  "mkdir /src/master/CVSROOT.adm".  Populate this
  90.     directory with the files from the "examples" directory included with
  91.     this release (loginfo and modules).  Edit these files
  92.     (/src/master/CVSROOT.adm/{loginfo,modules}) to reflect your local
  93.     source repository environment -- they may be quite small initially, but
  94.     will grow as sources are added to your source repository.  Turn these
  95.     files into RCS controlled files:
  96.  
  97.         cd /src/master/CVSROOT.adm
  98.         ci -m'Initial loginfo file' loginfo
  99.         ci -m'Initial modules file' modules
  100.  
  101. 8)  mkmodules /src/master/CVSROOT.adm
  102.  
  103.     This will build the ndbm(3) file for the modules database.  mkmodules
  104.     should have been installed above by the "make install" done in step 5.
  105.     If mkmodules cannot be found, check your PATH or try "rehash".
  106.  
  107. 9)  Have all users of the CVS system set the CVSROOT environment variable
  108.     appropriately to reflect the placement of your source repository.  If
  109.     the above example is used, the following commands can be placed in
  110.     user's ~/.login or ~/.profile file:
  111.  
  112.         setenv CVSROOT /src/master
  113.     for csh users, and
  114.         CVSROOT=/src/master; export CVSROOT
  115.     for sh users.
  116.  
  117. 10) It might be a good idea to jump right in and put the CVS distribution
  118.     directly under CVS control.  From within the top-level directory of the
  119.     CVS distribution (the one that contains this README file) do the
  120.     following commands:
  121.  
  122.         mkdir $CVSROOT/cvs
  123.         checkin -m 'CVS 1.0 distribution' cvs CVS CVS1_0
  124.  
  125. 11) Having done step 10, one should be able to checkout a copy of the CVS
  126.     distribution and hack away at the sources with the following command:
  127.  
  128.         cvs checkout cvs
  129.  
  130.     This will make the directory "cvs" in your current directory and
  131.     populate it with the appropriate CVS files and directories.
  132.  
  133. 12) Remember to edit the modules file manually when sources are checked in
  134.     with "checkin" or "cvs add".  A copy of the modules file for editing
  135.     can usually be retrieved with the "cvs checkout modules" command, and
  136.     definitely with the "cvs checkout CVSROOT.adm" command.
  137.  
  138. 13) PLEASE report any problems to me, berliner@prisma.com (Brian Berliner)
  139.     and I will try to collect patches and enhancements into future CVS
  140.     distributions.  "patch" format files are best, using context diffs,
  141.     if you will.
  142.  
  143. 14) GOOD LUCK!
  144.  
  145.                     Brian Berliner
  146.                     berliner@prisma.com
  147.