home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 22 gnu / 22-gnu.zip / cvs14p9b.zip / cvs / INSTALL < prev    next >
Text File  |  1994-11-05  |  9KB  |  211 lines
  1. First, read the README file.  If you're still happy...
  2.  
  3. The CVS 1.4 Alpha release has been tested on the following platforms.  Your
  4. mileage may vary.  Please send updates to this list using the "cvsbug"
  5. program, specifying the "portability" category.
  6.  
  7.     Gateway P5-66 (pentium) running Solaris 2.4
  8.     SPARCstation 1+ (sun4c) running SunOS 4.1.3
  9.     SPARCstation-10 (sun4m) running Solaris 2.4
  10.  
  11. NOTE:    CVS relies on having some form of the opendir/readdir/closedir
  12.     functions being available.  Some older systems do not support these
  13.     calls.  CVS will not work with these systems unless a suitable
  14.     readdir implementation is installed on the system.  Take a look at
  15.     the file "contrib/dirfns", which contains some code that might add
  16.     this support to your system.
  17.  
  18. -------------------------------------------------------------------------------
  19.  
  20. Installation:
  21.  
  22. 1)  Edit the src/options.h header file.  Appropriate things to look at may be
  23.     the invocation locations of programs like DIFF, GREP, RM, and SORT.
  24.     Also glance at the default values for the environment variables that
  25.     CVS uses, in particular, the RCSBIN variable, which holds the path to
  26.     where the RCS programs live on your system.  The likelihood is that you
  27.     don't have to change anything here, except perhaps adding the -a
  28.     option to DIFF if you are using GNU diff (which is strongly recommended).
  29.  
  30. 2)  Run "configure":
  31.  
  32.     $ ./configure
  33.  
  34.     You can specify an alternate destination to override the default with
  35.     the --prefix option:
  36.  
  37.     $ ./configure --prefix=/usr/local/gnu
  38.  
  39.     or some path that is more appropriate for your site.  The default prefix
  40.     value is "/usr/local", with binaries in sub-directory "bin", manual
  41.     pages in sub-directory "man", and libraries in sub-directory "lib".
  42.  
  43.     This release of CVS also requires RCS commands to be installed in the
  44.     user's PATH (or a path you have configured in src/options.h).  If you
  45.     don't have RCS, you will need to get it from GNU as well.  It is best
  46.     to get the version 5.6 (or later) version of RCS, available from
  47.     prep.ai.mit.edu in the file pub/gnu/rcs-5.6.tar.Z.  Along with RCS, you
  48.     will want to run GNU diff.  This will allow revision control of files
  49.     with binary data (a real nice feature).  You will need at least version
  50.     1.15 of GNU diff for this to work.  Be sure that you configure RCS to
  51.     work correctly with GNU diff to avoid other configuration problems.
  52.  
  53.     NOTE ON CVS's USE OF NDBM:
  54.  
  55.     By default, CVS uses some built-in ndbm emulation code to allow
  56.     CVS to work in a heterogeneous environment.  However, if you have
  57.     a very large modules database, this may not work well.  You will
  58.     need to edit src/options.h to turn off the MY_NDBM #define and
  59.     re-run configure.  If you do this, the following comments apply.
  60.     If not, you may safely skip these comments.
  61.  
  62.     If you configure CVS to use the real ndbm(3) libraries and
  63.     you do not have them installed in a "normal" place, you will
  64.     probably want to get the GNU version of ndbm (gdbm) and install
  65.     that before running the CVS configure script.  Be aware that the
  66.     GDBM 1.5 release does NOT install the <ndbm.h> header file included
  67.     with the release automatically.  You may have to install it by hand.
  68.  
  69.     If you configure CVS to use the ndbm(3) libraries, you cannot
  70.     compile CVS with GNU cc (gcc) on Sun-4 SPARC systems.  However, gcc
  71.     2.0 may have fixed this limitation if -fpcc-struct-return is
  72.     defined.  When using gcc on other systems to compile CVS, you *may*
  73.     need to specify the -fpcc-struct-return option to gcc (you will
  74.     *know* you have to if "cvs checkout" core dumps in some ndbm
  75.     function).  You can do this as follows:
  76.  
  77.         $ CC=gcc DEFS=-fpcc-struct-return ./configure
  78.  
  79.     for sh, bash, and ksh users and:
  80.  
  81.         % setenv CC gcc
  82.         % setenv DEFS -fpcc-struct-return
  83.         % ./configure
  84.  
  85.     for csh and tcsh users.
  86.  
  87.     END OF NOTE FOR NDBM GUNK.
  88.  
  89. 3)  Try to build it:
  90.  
  91.     $ make
  92.  
  93.     This will (hopefully) make the needed CVS binaries within the "src"
  94.     directory.  Send me your "config.status" file with your host type,
  95.     operating system information, and make output if something fails for
  96.     your system.
  97.  
  98. 4)  Install the binaries/documentation:
  99.  
  100.     $ make install
  101.  
  102.     Depending on your installation's configuration, you may need to be
  103.     root to do this.
  104.  
  105. 5)  Take a look at the CVS documentation.
  106.  
  107.     $ man cvs
  108.  
  109.     and
  110.  
  111.     $ info cvs  
  112.  
  113.     See what it can do for you, and if it fits your environment (or can
  114.     possibly be made to fit your environment).  If things look good,
  115.     continue on...
  116.  
  117. 6)  Setup the master source repository.  Choose a directory with ample disk
  118.     space available for source files.  This is where the RCS ",v" files
  119.     will be stored.  Note that this should be some shared directory for your
  120.     site.  It should probably be auto-mounted, if you're running NFS.
  121.  
  122.     Say you choose "/src/master" as the root of your source repository.
  123.     Run the "cvsinit" script to help you set it up.  It will ask you to
  124.     enter the path to your CVSROOT area.  You would enter /src/master in
  125.     this example.
  126.  
  127.     $ ./cvsinit
  128.  
  129.     The cvsinit script will setup a reasonable CVSROOT area to start with.
  130.     It is also valuable to folks who already have a CVSROOT area setup from
  131.     using earlier releases of CVS.  It assumes that you have installed CVS
  132.     already (step 4) and that the RCS programs (co and ci) are in your
  133.     PATH.  There are many ways to customize CVS for your site.  Read the
  134.     cvs(5) manual page when you get the chance.
  135.  
  136. 7)  Have all users of the CVS system set the CVSROOT environment variable
  137.     appropriately to reflect the placement of your source repository.  If
  138.     the above example is used, the following commands can be placed in
  139.     user's ~/.profile, ~/.bash_profile, or ~/.login file:
  140.  
  141.     CVSROOT=/src/master; export CVSROOT
  142.  
  143.     for sh/bash/ksh users, or
  144.  
  145.     setenv CVSROOT /src/master
  146.  
  147.     for csh/tcsh users.  If these environment variables are not already set
  148.     in your current shell, set them now (or source the login script you
  149.     just edited).  You will need to have the CVSROOT environment variable
  150.     set to continue on to the next step.
  151.  
  152. 8)  It might be a good idea to jump right in and put the CVS distribution
  153.     directly under CVS control.  From within the top-level directory of the
  154.     CVS distribution (the one that contains this README file) do the
  155.     following commands:
  156.  
  157.     $ make distclean
  158.     $ cvs import -m 'CVS 1.4 distribution' cvs CVS CVS1_4
  159.  
  160. 9)  Having done step 8, one should be able to checkout a fresh copy of the
  161.     CVS distribution and hack away at the sources with the following command:
  162.  
  163.     $ cd
  164.     $ cvs checkout cvs
  165.  
  166.     This will make the directory "cvs" in your current directory and
  167.     populate it with the appropriate CVS files and directories.
  168.  
  169. 10) Remember to edit the modules file manually when sources are checked in
  170.     with "cvs import" or "cvs add".  A copy of the modules file for editing
  171.     can usually be retrieved with the "cvs checkout modules" command, and
  172.     definitely with the "cvs checkout CVSROOT" command.  See cvs(5).
  173.  
  174. 11) Read the ChangeLog file to see what's new.  REALLY!  I use the
  175.     ChangeLog file as the Release Notes.
  176.  
  177. 12) Hack away.
  178.  
  179. -------------------------------------------------------------------------------
  180.  
  181. Detailed info about your interaction with "configure":
  182.  
  183. The "configure" script and its interaction with its options and the
  184. environment is described here.
  185.  
  186. Supported options are:
  187.     --srcdir=DIR        Useful for compiling on many different
  188.                 machines sharing one source tree.
  189.     --prefix=DIR        The root of where to install the
  190.                 various pieces of CVS (/usr/local).
  191.     --exec_prefix=DIR    If you want executables in a
  192.                 host-dependent place and shared
  193.                 things in a host-independent place.
  194.  
  195. The following environment variables override configure's default
  196. behaviour:
  197.     CC            If not set, tries to use gcc first,
  198.                 then cc.  Also tries to use "-g -O"
  199.                 as options, backing down to -g
  200.                 alone if that doesn't work.
  201.     INSTALL            If not set, tries to use "install", then
  202.                 "cp" as a final choice.
  203.     RANLIB            If not set, tries to determine if "ranlib"
  204.                 is available, choosing "echo" if it doesn't
  205.                 appear to be.
  206.     YACC            If not set, tries to determine if "bison"
  207.                 is available, choosing "yacc" if it doesn't
  208.                 appear to be.
  209.  
  210. -------------------------------------------------------------------------------
  211.