home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD2.mdf / c / library / os2 / rcs / rcs56src / source / cvs / readme < prev   
Encoding:
Text File  |  1991-02-06  |  6.2 KB  |  149 lines
  1. $Id: README,v 1.3.1.2 91/02/06 18:26:40 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. (now at Sun Microsystems, Inc.) converted
  40. ! the original CVS shell scripts into reasonably fast C and added many, many
  41. ! features to support software release control functions.  See the manual
  42. ! page in the "man" directory.  A copy of the USENIX article presented
  43. ! at the Winter 1990 USENIX Conference, Washington D.C., is included in
  44. ! the "doc" directory.
  45.  
  46. This code has been tested extensively on Sun-4 and Sun-3 platforms, all
  47. running SunOS 4.X.  Your mileage may vary for other systems, and I would
  48. really appreciate hearing back on what was necessary to get this beast
  49. working on other platforms.
  50.  
  51. Installation:
  52.  
  53. 1)  Edit the top-level Makefile (in this directory) and set DESTDIR to the
  54.     location of local binaries.  Also adjust CFLAGS and LDFLAGS
  55.     appropriately as well.  May also need to edit the man/Makefile file to
  56.     be sure that manual pages will be dropped in the correct place for your
  57.     system.
  58.  
  59. 2)  Edit the src/cvs.h header file.  Appropriate things to look at may be
  60.     the hard-coded locations of programs like DIFF, GREP, RM, and SORT.
  61.     Also glance at the default values for the environment variables that
  62.     CVS uses, in particular, the RCSBIN variable, which holds the path to
  63.     where the RCS programs live on your system.
  64.  
  65. 3)  make depend
  66.  
  67.     To get the Makefiles to use *your* include dependencies, not mine.
  68.  
  69. 4)  make
  70.  
  71.     This will (hopefully) make the needed CVS binaries within the "src"
  72.     directory.
  73.  
  74. 5)  make install
  75.  
  76.     If all goes well above, install the binaries and manual pages.
  77.     Depending on your instrallation's configuration, you may need to be
  78.     root to do this.
  79.  
  80. 6)  man cvs
  81.  
  82.     Take a look at the CVS manual page to see what it can do for you, and
  83.     if it fits your environment (or can possibly be made to fit your
  84.     environment).  If things look good, continue on...
  85.  
  86. 7)  Setup the master source repository.  Choose a directory with ample disk
  87.     space available for source files.  This is where the RCS ",v" files
  88.     will be stored.  Say you choose "/src/master" as the root of your
  89.     source repository.  Make the CVSROOT.adm directory in the root of the
  90.     source repository:  "mkdir /src/master/CVSROOT.adm".  Populate this
  91.     directory with the files from the "examples" directory included with
  92.     this release (loginfo and modules).  Edit these files
  93.     (/src/master/CVSROOT.adm/{loginfo,modules}) to reflect your local
  94.     source repository environment -- they may be quite small initially, but
  95.     will grow as sources are added to your source repository.  Turn these
  96.     files into RCS controlled files:
  97.  
  98.         cd /src/master/CVSROOT.adm
  99.         ci -m'Initial loginfo file' loginfo
  100.         ci -m'Initial modules file' modules
  101.  
  102. 8)  mkmodules /src/master/CVSROOT.adm
  103.  
  104.     This will build the ndbm(3) file for the modules database.  mkmodules
  105.     should have been installed above by the "make install" done in step 5.
  106.     If mkmodules cannot be found, check your PATH or try "rehash".
  107.  
  108. 9)  Have all users of the CVS system set the CVSROOT environment variable
  109.     appropriately to reflect the placement of your source repository.  If
  110.     the above example is used, the following commands can be placed in
  111.     user's ~/.login or ~/.profile file:
  112.  
  113.         setenv CVSROOT /src/master
  114.     for csh users, and
  115.         CVSROOT=/src/master; export CVSROOT
  116.     for sh users.
  117.  
  118. 10) It might be a good idea to jump right in and put the CVS distribution
  119.     directly under CVS control.  From within the top-level directory of the
  120.     CVS distribution (the one that contains this README file) do the
  121.     following commands:
  122.  
  123.         mkdir $CVSROOT/cvs
  124.         make clean
  125.         checkin -m 'CVS 1.0 distribution' cvs CVS CVS1_0
  126.  
  127. 11) Having done step 10, one should be able to checkout a copy of the CVS
  128.     distribution and hack away at the sources with the following command:
  129.  
  130.         cvs checkout cvs
  131.  
  132.     This will make the directory "cvs" in your current directory and
  133.     populate it with the appropriate CVS files and directories.
  134.  
  135. 12) Remember to edit the modules file manually when sources are checked in
  136.     with "checkin" or "cvs add".  A copy of the modules file for editing
  137.     can usually be retrieved with the "cvs checkout modules" command, and
  138.     definitely with the "cvs checkout CVSROOT.adm" command.
  139.  
  140. 13) PLEASE report any problems to me, berliner@sun.com (Brian Berliner)
  141.     and I will try to collect patches and enhancements into future CVS
  142.     distributions.  "patch" format files are best, using context diffs,
  143.     if you will.
  144.  
  145. 14) GOOD LUCK!
  146.  
  147.                     Brian Berliner
  148.                     berliner@sun.com
  149.